Mission Class Reference

Inheritance diagram for Mission:
OwnedSecurableItem MashableActivityInterface MashableInboxInterface SecurableItem Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()
 onCreated ()

Static Public Member Functions

static getMashableActivityRulesType ()
static getMashableInboxRulesType ()
static getModuleClassName ()
static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()
static hasReadPermissionsOptimization ()
static getGamificationRulesType ()
static hasRelatedItems ()

Data Fields

const STATUS_AVAILABLE = 1
const STATUS_TAKEN = 2
const STATUS_COMPLETED = 3
const STATUS_REJECTED = 4
const STATUS_ACCEPTED = 5

Protected Member Functions

 beforeSave ()
 afterSave ()

Static Protected Member Functions

static translatedAttributeLabels ($language)

Detailed Description

Class for creating Mission models. A mission is similar to a task except a user can only have one mission at a time and a mission cannot be assigned. A user must take a mission.

Definition at line 41 of file Mission.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 67 of file Mission.php.

onCreated (  ) 

Called on construction when a new model is created.

Reimplemented from Item.

Definition at line 83 of file Mission.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 Mission.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 OwnedSecurableItem.

Definition at line 99 of file Mission.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 OwnedSecurableItem.

Definition at line 167 of file Mission.php.

static hasReadPermissionsOptimization (  )  [static]

Override on any models you want to utilize ReadPermissionsOptimization

Reimplemented from SecurableItem.

Definition at line 172 of file Mission.php.

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

Reimplemented from Item.

Definition at line 177 of file Mission.php.

beforeSave (  )  [protected]

Alter takenByUserHasReadLatest and/or ownerHasReadLatest based on comments being added. (non-PHPdoc)

See also:
Item::beforeSave()

Reimplemented from Item.

Definition at line 187 of file Mission.php.

afterSave (  )  [protected]

After a mission is saved, if it is new, then a notification should go out to all users alerting them of a new mission. Depending on the status change of the mission, a notification can go out as well to the owner or user who has taken the mission.

Reimplemented from OwnedSecurableItem.

Definition at line 252 of file Mission.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu Nov 23 07:10:27 2017