Comment Class Reference

Inheritance diagram for Comment:
Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()

Static Public Member Functions

static getByDescription ($description)
static getCommentsByRelatedModelTypeIdAndPageSize ($type, $relatedId, $pageSize)
static getModuleClassName ()
static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()
static getGamificationRulesType ()

Static Protected Member Functions

static translatedAttributeLabels ($language)

Detailed Description

Model for storing comments that relate to a variety of different models across the application.

Definition at line 40 of file Comment.php.


Member Function Documentation

static getByDescription ( description  )  [static]
Parameters:
string $description

Definition at line 45 of file Comment.php.

__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 61 of file Comment.php.

static getCommentsByRelatedModelTypeIdAndPageSize ( type,
relatedId,
pageSize 
) [static]

Given a related model type, a related model id, and a page size, return a list of comment models.

Parameters:
string $type
integer $relatedId
integer $pageSize

Definition at line 76 of file Comment.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 94 of file Comment.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 Item.

Definition at line 99 of file Comment.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 Item.

Definition at line 122 of file Comment.php.

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

Reimplemented from Item.

Definition at line 127 of file Comment.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Wed Jun 28 07:10:23 2017