GameScore Class Reference

Inheritance diagram for GameScore:
Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()
 addValue ()

Static Public Member Functions

static resolveToGetByTypeAndPerson ($type, Item $person)
static getAllByPersonIndexedByType (Item $person)
static getModuleClassName ()
static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()

Static Protected Member Functions

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

Detailed Description

Manages game scores.

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

static resolveToGetByTypeAndPerson ( type,
Item person 
) [static]

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

Returns:
The found or created model.
Parameters:
string $type
Item $person

Definition at line 57 of file GameScore.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 score type.

Parameters:
Item $person

Definition at line 99 of file GameScore.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 129 of file GameScore.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 134 of file GameScore.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 167 of file GameScore.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 177 of file GameScore.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 187 of file GameScore.php.

addValue (  ) 

Add a single point of value to the value count.

Definition at line 195 of file GameScore.php.


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