class CommunityModelInbox extends JCCModel implements CNotificationsInterface


Located at : UKNOWVA_ROOT/components/com_community/models/inbox.php

Properties

$_data
$_pagination

Methods

__construct(array $config = array())

Constructor

from JModel
string
__toString()

Magic method to convert the object to a string gracefully.

from JObject
mixed
def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

from JObject
mixed
get(string $property, mixed $default = null)

Returns a property of the object or the default value if the property is not set.

from JObject
array
getProperties(boolean $public = true)

Returns an associative array of object properties.

from JObject
string
getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

from JObject
array
getErrors()

Return all errors, if any.

from JObject
mixed
set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

from JObject
boolean
setProperties(mixed $properties)

Set the object properties based on a named array/hash.

from JObject
void
setError(string $error)

Add an error message.

from JObject
string
toString() deprecated

No description

from JObject
static array
addIncludePath(mixed $path = '', string $prefix = '')

Add a directory where JModel should search for models. You may either pass a string or an array of directories.

from JModel
static void
addTablePath(mixed $path)

Adds to the stack of model table paths in LIFO order.

from JModel
static mixed
getInstance(string $type, string $prefix = '', array $config = array())

Returns a Model object, always creating it

from JModel
getDbo()

Method to get the database connector object

from JModel
string
getName()

Method to get the model name

from JModel
object
getState(string $property = null, mixed $default = null)

Method to get model state variables

from JModel
getTable(string $name = '', string $prefix = 'Table', array $options = array())

Method to get a table object, load it if necessary.

from JModel
void
setDbo(object $db)

Method to set the database connector object

from JModel
mixed
setState(string $property, mixed $value = null)

Method to set model state variables

from JModel
JCCModel()

No description

from JCCModel
getNotes()

No description

from JCCModel
getSample()

No description

from JCCModel
store()

No description

from JCCModel
CommunityModelInbox()

Constructor to set the limit

getInbox($_isread = true)

Return the conversation list

getParent($msgId)

get Parent

getPagination()

get pagination

getSent()

Return list of sent items

getFullMessages($id)

Return the full messages

getSentMessages($id)

Return the sent messages for later removal.

getMessage($id)

Return the message

getRecepientMessage($id)

Return the recepient message

getLastSentTime($id)

Return the time the given user send the last message

getUserMessage($id)

Return the latest recepient message based on parent message id.

getMessages($filter = array(), $read = false)

No description

send($vars)

No description

sendReply($obj, $replyMsgId)

No description

addReceipient($msgObj, $recepientId)

Add receipient

removeReceivedMsg($msgId, $userid)

Remove the received message

getUserId($param = array())

No description

markMessageAsRead($filter)

Mark a message as "read" (opened)

markMessageAsUnread($filter)

Mark a message as "new"

markAsRead($filter)

Mark a message as "read" (opened) from Inbox page

markAsUnread($filter)

Mark a message as "read" (opened) from Inbox page

canReply($userid, $msgId)

Check if the user can reply to this message thread

canRead(string $userid, string $msgId)

Check if user can read this message.

getTotalMessageSent($userId)

No description

int
countUnRead($filter)

Get unread message count for current user

getRecepientCount($filter)

Get total recepient conversation message count for a message.

getParticipantsID($msgid, $exclusion, $include_to = true)

Given any message id, return an array of userid that are involved in the conversation, be it recipient or sender.

getMultiRecepientID($filter = array())

Get all recepient user id for a message except the current userid.

getUnReadInbox()

Get current user all the unread messages param user_id

getLatestMessage($filter = array(), $limit = 5)

Get current user latest messages param user_id param limit (optional)

getUserInboxCount()

No description

getTotalNotifications($userId)

Returns a list of unread or notifications for the users inbox

Details

in JModel at line 202
JObject __construct(array $config = array())

Constructor

Parameters

array $config An array of configuration options (name, state, dbo, tablepath, ignorerequest).

Return Value

JObject

in JObject at line 56
string __toString()

Magic method to convert the object to a string gracefully.

Return Value

string The classname.

in JObject at line 70
mixed def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed

in JObject at line 88
mixed get(string $property, mixed $default = null)

Returns a property of the object or the default value if the property is not set.

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed The value of the property.

See also

getProperties()

in JObject at line 107
array getProperties(boolean $public = true)

Returns an associative array of object properties.

Parameters

boolean $public If true, returns only the public properties.

Return Value

array

See also

get()

in JObject at line 133
string getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

Parameters

integer $i Option error index.
boolean $toString Indicates if JError objects should return their error message.

Return Value

string Error message

in JObject at line 165
array getErrors()

Return all errors, if any.

Return Value

array Array of error messages or JErrors.

in JObject at line 180
mixed set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

Parameters

string $property The name of the property.
mixed $value The value of the property to set.

Return Value

mixed Previous value of the property.

in JObject at line 198
boolean setProperties(mixed $properties)

Set the object properties based on a named array/hash.

Parameters

mixed $properties Either an associative array or another object.

Return Value

boolean

See also

set()

in JObject at line 222
void setError(string $error)

Add an error message.

Parameters

string $error Error message.

Return Value

void

in JObject at line 235
string toString() deprecated

deprecated 12.1 Use magic method __toString()

Return Value

string

See also

__toString()

in JModel at line 84
static array addIncludePath(mixed $path = '', string $prefix = '')

Add a directory where JModel should search for models. You may either pass a string or an array of directories.

Parameters

mixed $path A path or array[sting] of paths to search.
string $prefix A prefix for models.

Return Value

array An array with directory elements. If prefix is equal to '', all directories are returned.

in JModel at line 123
static void addTablePath(mixed $path)

Adds to the stack of model table paths in LIFO order.

Parameters

mixed $path The directory as a string or directories as an array to add.

Return Value

void

in JModel at line 161
static mixed getInstance(string $type, string $prefix = '', array $config = array())

Returns a Model object, always creating it

Parameters

string $type The model type to instantiate
string $prefix Prefix for the model class name. Optional.
array $config Configuration array for model. Optional.

Return Value

mixed A model object or false on failure

in JModel at line 327
JDatabase getDbo()

Method to get the database connector object

Return Value

JDatabase JDatabase connector object

in JModel at line 341
string getName()

Method to get the model name

The model name. By default parsed using the classname or it can be set by passing a $config['name'] in the class constructor

Return Value

string The name of the model

in JModel at line 365
object getState(string $property = null, mixed $default = null)

Method to get model state variables

Parameters

string $property Optional parameter name
mixed $default Optional default value

Return Value

object The property where specified, the state object where omitted

in JModel at line 388
JTable getTable(string $name = '', string $prefix = 'Table', array $options = array())

Method to get a table object, load it if necessary.

Parameters

string $name The table name. Optional.
string $prefix The class prefix. Optional.
array $options Configuration array for model. Optional.

Return Value

JTable A JTable object

in JModel at line 427
void setDbo(object $db)

Method to set the database connector object

Parameters

object $db &$db A JDatabase based object

Return Value

void

in JModel at line 441
mixed setState(string $property, mixed $value = null)

Method to set model state variables

Parameters

string $property The name of the property.
mixed $value The value of the property to set or null.

Return Value

mixed The previous value of the property or null if not set.

in JCCModel at line 13
JCCModel()

in JCCModel at line 18
getNotes()

in JCCModel at line 22
getSample()

in JCCModel at line 28
store()

at line 28
CommunityModelInbox()

Constructor to set the limit

at line 47
getInbox($_isread = true)

Return the conversation list

Parameters

$_isread

at line 137
getParent($msgId)

get Parent

Parameters

$msgId

at line 159
getPagination()

get pagination

at line 167
getSent()

Return list of sent items

at line 254
getFullMessages($id)

Return the full messages

Parameters

$id

at line 272
getSentMessages($id)

Return the sent messages for later removal.

Parameters

$id

at line 294
getMessage($id)

Return the message

Parameters

$id

at line 312
getRecepientMessage($id)

Return the recepient message

Parameters

$id

at line 330
getLastSentTime($id)

Return the time the given user send the last message

Parameters

$id

at line 353
getUserMessage($id)

Return the latest recepient message based on parent message id.

Parameters

$id

at line 374
getMessages($filter = array(), $read = false)

Parameters

$filter
$read

at line 455
send($vars)

Parameters

$vars

at line 511
sendReply($obj, $replyMsgId)

Parameters

$obj
$replyMsgId

at line 561
addReceipient($msgObj, $recepientId)

Add receipient

Parameters

$msgObj
$recepientId

at line 584
removeReceivedMsg($msgId, $userid)

Remove the received message

Parameters

$msgId
$userid

at line 648
getUserId($param = array())

Parameters

$param

at line 684
markMessageAsRead($filter)

Mark a message as "read" (opened)

Parameters

$filter

at line 706
markMessageAsUnread($filter)

Mark a message as "new"

Parameters

$filter

at line 728
markAsRead($filter)

Mark a message as "read" (opened) from Inbox page

Parameters

$filter

at line 750
markAsUnread($filter)

Mark a message as "read" (opened) from Inbox page

Parameters

$filter

at line 770
canReply($userid, $msgId)

Check if the user can reply to this message thread

Parameters

$userid
$msgId

at line 788
canRead(string $userid, string $msgId)

Check if user can read this message.

Parameters

string $userid userid
string $msgId msgID : should be the parent message

at line 793
getTotalMessageSent($userId)

Parameters

$userId

at line 818
int countUnRead($filter)

Get unread message count for current user

Parameters

$filter

Return Value

int unread message count

at line 848
getRecepientCount($filter)

Get total recepient conversation message count for a message.

Parameters

$filter

at line 874
getParticipantsID($msgid, $exclusion, $include_to = true)

Given any message id, return an array of userid that are involved in the conversation, be it recipient or sender.

$include_to was introduced by vicky , if it is set to false, then the particpants returned will always be the people who have sent message on this at least once this issue was reported by dinesh dhoka when somene sends a bulk mailer to many user, all replies are also marked to all users....which some how causes spamming

Parameters

$msgid
$exclusion
$include_to

at line 922
getMultiRecepientID($filter = array())

Get all recepient user id for a message except the current userid.

Parameters

$filter

at line 951
getUnReadInbox()

Get current user all the unread messages param user_id

at line 976
getLatestMessage($filter = array(), $limit = 5)

Get current user latest messages param user_id param limit (optional)

Parameters

$filter
$limit

at line 1001
getUserInboxCount()

at line 1053
getTotalNotifications($userId)

Returns a list of unread or notifications for the users inbox

Parameters

$userId