Warning: mysql_connect(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /home/zurmoorg/public_html/z-header.php on line 8

Deprecated: mysql_connect(): The mysql extension is deprecated and will be removed in the future: use mysqli or PDO instead in /home/zurmoorg/public_html/z-header.php on line 8

MashableInboxRules Class Reference

Inheritance diagram for MashableInboxRules:
ConversationMashableInboxRules MissionMashableInboxRules NotificationMashableInboxRules

Public Member Functions

 getUnreadCountForCurrentUser ()
 hasCurrentUserReadLatest ($modelId)
 getMetadataFilteredByFilteredBy ($filteredBy)
 getMetadataFilteredByOption ($option)
 getActionViewOptions ()
 getModelClassName ()
 getMachableInboxOrderByAttributeName ()
 resolveMarkRead ($modelId)
 resolveMarkUnread ($modelId)
 getSearchAttributeData ($searchTerm)
 getMetadataForMashableInbox ()
 getListViewClassName ()
 getZeroModelViewClassName ()
 getListView ($option, $filteredBy=MashableInboxForm::FILTERED_BY_ALL, $searchTerm=null, $starred=false)
 getModelStringContent (RedBeanModel $model)
 getModelCreationTimeContent (RedBeanModel $model)
 getSummaryContentTemplate ()
 getMassOptions ()
 hasUserReadLatest ($model, User $user)
 markUserAsHavingUnreadLatestModel ($model, User $user)
 markUserAsHavingReadLatestModel ($model, User $user)
 makePersonWhoHasNotReadLatest ($personOrUserModel)

Data Fields

 $shouldRenderCreateAction = false

Protected Member Functions

 getHaveNotReadRelationName ()
 getPersonWhoHasNotReadLatestModelName ()
 addPersonWhoHasNotReadLatestToModel ($model, $personWhoHasNotReadLatest)
 removePersonWhoHasNotReadLatestToModel ($model, $personWhoHasNotReadLatest)

Detailed Description

Class to help interacting with classes that implement the MashableInboxInterface.

Definition at line 40 of file MashableInboxRules.php.


Member Function Documentation

getUnreadCountForCurrentUser (  )  [abstract]

This method return the count of the models that current user has not read latest changes

Returns:
integer

Reimplemented in ConversationMashableInboxRules, MissionMashableInboxRules, and NotificationMashableInboxRules.

hasCurrentUserReadLatest ( modelId  )  [abstract]

Returns true if current user had read latest changes of model else it should return false

Parameters:
integer $modelId
Returns:
boolean

Reimplemented in ConversationMashableInboxRules, MissionMashableInboxRules, and NotificationMashableInboxRules.

getMetadataFilteredByFilteredBy ( filteredBy  )  [abstract]

Returns the metada for the FilteredBy

Parameters:
string $filteredBy

Reimplemented in ConversationMashableInboxRules, MissionMashableInboxRules, and NotificationMashableInboxRules.

getMetadataFilteredByOption ( option  )  [abstract]

Returns the metada for the filter by model options

Parameters:
integer $option

Reimplemented in ConversationMashableInboxRules, MissionMashableInboxRules, and NotificationMashableInboxRules.

getActionViewOptions (  )  [abstract]

Returns the option to populate the MashableInboxOptionsByModelRadioElement that will be used to filter list view by model options

Reimplemented in ConversationMashableInboxRules, MissionMashableInboxRules, and NotificationMashableInboxRules.

getMachableInboxOrderByAttributeName (  )  [abstract]

The attribute to be used for the ordering of the list view

Reimplemented in ConversationMashableInboxRules, MissionMashableInboxRules, and NotificationMashableInboxRules.

resolveMarkRead ( modelId  )  [abstract]

Marks the model as read latest changes by current user by modelId

Parameters:
integer $modelId

Reimplemented in ConversationMashableInboxRules, MissionMashableInboxRules, and NotificationMashableInboxRules.

resolveMarkUnread ( modelId  )  [abstract]

Marks the model as read latest changes by current user by modelId

Parameters:
integer $modelId

Reimplemented in ConversationMashableInboxRules, MissionMashableInboxRules, and NotificationMashableInboxRules.

getSearchAttributeData ( searchTerm  ) 

Makes the metadata to filter models by the searchTerm

Parameters:
string $searchTerm

Reimplemented in ConversationMashableInboxRules, MissionMashableInboxRules, and NotificationMashableInboxRules.

Definition at line 104 of file MashableInboxRules.php.

getMetadataForMashableInbox (  ) 

Makes the metadata to be used when searching models that will be displayed in the MashableInboxListView

Reimplemented in ConversationMashableInboxRules, and MissionMashableInboxRules.

Definition at line 113 of file MashableInboxRules.php.

getListViewClassName (  ) 

The list view class name that will be displayed for the current model

Returns:
string

Reimplemented in NotificationMashableInboxRules.

Definition at line 122 of file MashableInboxRules.php.

getZeroModelViewClassName (  ) 

The list view class name that will be used to display a ZeroModelView

Returns:
string

Reimplemented in NotificationMashableInboxRules.

Definition at line 133 of file MashableInboxRules.php.

getModelStringContent ( RedBeanModel model  ) 

The content to be displayed in the MashableInboxListView row

Parameters:
RedBeanModel $model
Returns:
string

Reimplemented in NotificationMashableInboxRules.

Definition at line 180 of file MashableInboxRules.php.

getModelCreationTimeContent ( RedBeanModel model  ) 

A string containing the time passed from latest changes on the model to be used in the MashableInboxListView row

Parameters:
RedBeanModel $model
Returns:
string

Reimplemented in NotificationMashableInboxRules.

Definition at line 206 of file MashableInboxRules.php.

getSummaryContentTemplate (  ) 

Template to display the models rows content

Returns:
string

Definition at line 215 of file MashableInboxRules.php.

getMassOptions (  ) 

Mass options to be rendered in the MashableInboxMassActionElement The array retunr should be like this array('stringForTheActionName' => array('label' => $label, 'isActionForAll' => $boolean), );

Returns:
array

Reimplemented in ConversationMashableInboxRules, and NotificationMashableInboxRules.

Definition at line 228 of file MashableInboxRules.php.

hasUserReadLatest ( model,
User user 
)

Given the model, check if the a user has read latest changes

Parameters:
$model 
User $user

Definition at line 238 of file MashableInboxRules.php.

markUserAsHavingUnreadLatestModel ( model,
User user 
)
Parameters:
$model 
User $user

Definition at line 258 of file MashableInboxRules.php.

markUserAsHavingReadLatestModel ( model,
User user 
)
Parameters:
$model 
User $user

Definition at line 273 of file MashableInboxRules.php.

makePersonWhoHasNotReadLatest ( personOrUserModel  ) 

Makes an return a PersonWhoHasNotReadLatest based on the person or user

Parameters:
$personOrUserModel 

Definition at line 292 of file MashableInboxRules.php.

getHaveNotReadRelationName (  )  [protected]

This method should return the name of the model relation that contains the persons who have not read the latest changes

Returns:
string

Definition at line 306 of file MashableInboxRules.php.

getPersonWhoHasNotReadLatestModelName (  )  [protected]

Retunr the model name where is stored the users or persons who have not read the latest changes of the model

Returns:
string

Definition at line 316 of file MashableInboxRules.php.

addPersonWhoHasNotReadLatestToModel ( model,
personWhoHasNotReadLatest 
) [protected]

Add a person who has not read the model latest changes

Parameters:
$model 
$personWhoHasNotReadLatest 

Definition at line 326 of file MashableInboxRules.php.

removePersonWhoHasNotReadLatestToModel ( model,
personWhoHasNotReadLatest 
) [protected]

Removes a person from the one that has not read the model latest changes

Parameters:
$model 
$personWhoHasNotReadLatest 

Definition at line 337 of file MashableInboxRules.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon Mar 25 07:10:55 2019

Warning: mysql_connect(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /home/zurmoorg/public_html/z-footer.php on line 8

Deprecated: mysql_connect(): The mysql extension is deprecated and will be removed in the future: use mysqli or PDO instead in /home/zurmoorg/public_html/z-footer.php on line 8