Role Class Reference

Inheritance diagram for Role:
Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()

Static Public Member Functions

static getByName ($name)
static getDefaultMetadata ()
static isTypeDeletable ()
static getModuleClassName ()

Protected Member Functions

 afterSave ()
 beforeSave ()
 beforeDelete ()
 afterDelete ()
 beforeValidate ()
 checkIfParentIsNotInChildRoles ($roles)

Static Protected Member Functions

static translatedAttributeLabels ($language)

Detailed Description

Definition at line 37 of file Role.php.


Member Function Documentation

static getByName ( name  )  [static]
Parameters:
string $name
Exceptions:
NotFoundException 

Reimplemented from Item.

Definition at line 43 of file Role.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 56 of file Role.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 76 of file Role.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 99 of file Role.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 119 of file Role.php.

beforeDelete (  )  [protected]

This method is invoked before deleting a record. The default implementation raises the onBeforeDelete event. You may override this method to do any preparation work for record deletion. Make sure you call the parent implementation so that the event is raised properly.

Returns:
boolean whether the record should be deleted. Defaults to true.

Reimplemented from RedBeanModel.

Definition at line 141 of file Role.php.

afterDelete (  )  [protected]

This method is invoked after deleting a record. The default implementation raises the onAfterDelete event. You may override this method to do postprocessing after the record is deleted. Make sure you call the parent implementation so that the event is raised properly.

Reimplemented from RedBeanModel.

Definition at line 151 of file Role.php.

beforeValidate (  )  [protected]

See the yii documentation.

Reimplemented from RedBeanModel.

Definition at line 158 of file Role.php.

checkIfParentIsNotInChildRoles ( roles  )  [protected]

Recursively

Parameters:
$roles 
Returns:
bool

Definition at line 174 of file Role.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Tue May 23 07:10:29 2017