GameBadge Class Reference

Inheritance diagram for GameBadge:
Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()

Static Public Member Functions

static getAllByPersonIndexedByType (Item $person)
static getModuleClassName ()
static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()
static processBonusPoints (GameBadge $gameBadge, User $user, $gradeChangeOrNewBadge)

Static Protected Member Functions

static getLabel ($language=null)
static getPluralLabel ($language=null)

Detailed Description

Model for game badges

Definition at line 40 of file GameBadge.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 42 of file GameBadge.php.

static getAllByPersonIndexedByType ( Item person  )  [static]

Given a Item (Either User or Person), Try to find an existing models and index the returning array by badge type.

Parameters:
Item $person

Definition at line 56 of file GameBadge.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 86 of file GameBadge.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 91 of file GameBadge.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 125 of file GameBadge.php.

static processBonusPoints ( GameBadge gameBadge,
User user,
gradeChangeOrNewBadge 
) [static]

Given a user and a gameBadge, process the bonus points, if applicable for the badge. This will also process grade change points for the given badge.

Parameters:
GameBadge $gameBadge
User $user
$gradeChangeOrNewBadge 
Exceptions:
NotSupportedException 

Definition at line 138 of file GameBadge.php.

static getLabel ( language = null  )  [static, protected]

Returns the display name for the model class.

Parameters:
null | string $language
Returns:
dynamic label name based on module.

Reimplemented from RedBeanModel.

Definition at line 174 of file GameBadge.php.

static getPluralLabel ( language = null  )  [static, protected]

Returns the display name for plural of the model class.

Parameters:
null | string $language
Returns:
dynamic label name based on module.

Reimplemented from RedBeanModel.

Definition at line 184 of file GameBadge.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Fri Mar 24 07:10:26 2017