GameCoin Class Reference

Inheritance diagram for GameCoin:
Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()
 addValue ($value)
 removeValue ($value)

Static Public Member Functions

static resolveByPerson (Item $person)
static getModuleClassName ()
static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()
static showCoin (CController $controller)

Static Protected Member Functions

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

Detailed Description

Model for game coins

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

static resolveByPerson ( Item person  )  [static]

Given an Item (Either User or Person), try to find an existing model. If the model does not exist, create it and populate the Item.

Parameters:
Item $person
Returns:
The found or created model.
Exceptions:
NotSupportedException 

Definition at line 58 of file GameCoin.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 GameCoin.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 GameCoin.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 129 of file GameCoin.php.

static showCoin ( CController $  controller  )  [static]

Eventually refactor to support different randomness seeds on a per module basis, but until this is fleshed out more, we will just hard-code the seeding here.

Definition at line 138 of file GameCoin.php.

addValue ( value  ) 

Add specified value.

Definition at line 159 of file GameCoin.php.

removeValue ( value  ) 

Remove a specified value. Typically used during game reward redemption

Parameters:
$value 

Definition at line 169 of file GameCoin.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 180 of file GameCoin.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 190 of file GameCoin.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sat May 27 07:10:25 2017