Note Class Reference

Inheritance diagram for Note:
MashableActivity Activity MashableActivityInterface OwnedSecurableItem SecurableItem Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()

Static Public Member Functions

static getByName ($name)
static getModuleClassName ()
static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()
static getMashableActivityRulesType ()
static hasReadPermissionsOptimization ()
static getGamificationRulesType ()

Protected Member Functions

 beforeSave ()

Static Protected Member Functions

static translatedAttributeLabels ($language)

Detailed Description

Definition at line 37 of file Note.php.


Member Function Documentation

static getByName ( name  )  [static]

Gets by name

Parameters:
string $name
Returns:
string

Reimplemented from Activity.

Definition at line 39 of file Note.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 44 of file Note.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 Activity.

Definition at line 66 of file Note.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 Activity.

Definition at line 71 of file Note.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 Activity.

Definition at line 109 of file Note.php.

beforeSave (  )  [protected]

Special handling of the import scenario. When you are importing a model, you can potentially set the created/modified user/datetime which is normally not allowed since they are read-only attributes. This logic helps to allow for this special use case.

See also:
RedBeanModel::beforeSave()

Reimplemented from Item.

Definition at line 114 of file Note.php.

static hasReadPermissionsOptimization (  )  [static]

Override on any models you want to utilize ReadPermissionsOptimization

Reimplemented from SecurableItem.

Definition at line 136 of file Note.php.

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

Reimplemented from Item.

Definition at line 141 of file Note.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Wed Jul 26 07:10:27 2017