Conversation Class Reference

Inheritance diagram for Conversation:
OwnedSecurableItem MashableActivityInterface MashableInboxInterface StarredInterface SecurableItem Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()
 resolveIsClosedForNull ()
 onCreated ()

Static Public Member Functions

static getMashableActivityRulesType ()
static getMashableInboxRulesType ()
static getBySubject ($subject)
static getUnreadCountByUser (User $user)
static getModuleClassName ()
static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()
static hasReadPermissionsOptimization ()
static getGamificationRulesType ()
static hasRelatedItems ()

Protected Member Functions

 beforeSave ()

Static Protected Member Functions

static translatedAttributeLabels ($language)
static getModifiedSignalAttribute ()

Detailed Description

Base model for working with a conversation

Definition at line 40 of file Conversation.php.


Member Function Documentation

__toString (  ) 

Returns the displayable string for the class. Should be overridden in any model that can provide a meaningful string representation of itself.

Returns:
A string.

Reimplemented from RedBeanModel.

Definition at line 75 of file Conversation.php.

static getModifiedSignalAttribute (  )  [static, protected]
See also:
OwnedSecurableItem::getModifiedSignalAttribute()
Returns:
string

Reimplemented from OwnedSecurableItem.

Definition at line 95 of file Conversation.php.

static getUnreadCountByUser ( User user  )  [static]

Given a user get the count of conversations that have unread comments.

Parameters:
object $user User

Definition at line 116 of file Conversation.php.

onCreated (  ) 

Called on construction when a new model is created.

Reimplemented from Item.

Definition at line 149 of file Conversation.php.

static canSaveMetadata (  )  [static]

By default models cannot save their metadata, allowing them to be loaded quickly because the loading of of metadata can be avoided as much as possible. To make a model able to save its metadata override this method to return true. PUT it before the getDefaultMetadata in the derived class.

Reimplemented from RedBeanModel.

Definition at line 160 of file Conversation.php.

static getDefaultMetadata (  )  [static]

Returns the default meta data for the class. It must be appended to the meta data from the parent model, if any.

Reimplemented from OwnedSecurableItem.

Definition at line 165 of file Conversation.php.

static isTypeDeletable (  )  [static]

To be overriden on intermediate derived classes to return false so that deletes are not done on intermediate classes because the object relational mapping will not clean up properly. For example if User is a Person, and Person is a RedBeanModel delete should be called only on User, not on Person. So User must override isDeletable to return false.

Reimplemented from OwnedSecurableItem.

Definition at line 217 of file Conversation.php.

static hasReadPermissionsOptimization (  )  [static]

Override on any models you want to utilize ReadPermissionsOptimization

Reimplemented from SecurableItem.

Definition at line 222 of file Conversation.php.

static getGamificationRulesType (  )  [static]
Returns:
string of gamificationRulesType Override for a child class as needed.

Reimplemented from Item.

Definition at line 227 of file Conversation.php.

beforeSave (  )  [protected]

Alter hasReadLatest and/or ownerHasReadLatest based on comments being added. (non-PHPdoc)

See also:
Item::beforeSave()

Reimplemented from Item.

Definition at line 237 of file Conversation.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon Oct 14 07:10:54 2019