Campaign Class Reference

Inheritance diagram for Campaign:
OwnedSecurableItem SecurableItem Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()
 getErrors ($attributeNameOrNames=null)
 beforeValidate ()

Static Public Member Functions

static getByName ($name)
static getModuleClassName ()
static getStatusDropDownArray ()
static canSaveMetadata ()
static isTypeDeletable ()
static getByStatus ($status, $pageSize=null)
static getByStatusAndSendingTime ($status, $sendingTimestamp=null, $pageSize=null, $offset=null, $inPast=true)
static getDefaultMetadata ()
static hasReadPermissionsOptimization ()
static getGamificationRulesType ()

Data Fields

const STATUS_PAUSED = 1
const STATUS_ACTIVE = 2
const STATUS_PROCESSING = 3
const STATUS_COMPLETED = 4

Protected Member Functions

 validateHtmlOnly ()
 afterSave ()

Static Protected Member Functions

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

Detailed Description

Definition at line 37 of file Campaign.php.


Member Function Documentation

static getByName ( name  )  [static]

Gets by name

Parameters:
string $name
Returns:
string

Reimplemented from Item.

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

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

Returns the display name for the model class.

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

Reimplemented from RedBeanModel.

Definition at line 88 of file Campaign.php.

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

Returns the display name for plural of the model class.

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

Reimplemented from RedBeanModel.

Definition at line 98 of file Campaign.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 103 of file Campaign.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 108 of file Campaign.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 167 of file Campaign.php.

static hasReadPermissionsOptimization (  )  [static]

Override on any models you want to utilize ReadPermissionsOptimization

Reimplemented from SecurableItem.

Definition at line 252 of file Campaign.php.

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

Reimplemented from Item.

Definition at line 257 of file Campaign.php.

getErrors ( attributeNameOrNames = null  ) 

See the yii documentation. The yii getErrors() takes an optional attribute name. RedBeanModel's getErrors() takes an optional attribute name or array of attribute names.

Parameters:
@attributeNameOrNames Either null, return all errors on the model and its related models, an attribute name on the model, return errors on that attribute, or an array of relation and attribute names, return errors on a related model's attribute.

Reimplemented from RedBeanModel.

Definition at line 262 of file Campaign.php.

beforeValidate (  ) 

See the yii documentation.

Reimplemented from RedBeanModel.

Definition at line 271 of file Campaign.php.

afterSave (  )  [protected]

Handle Permitable Attachment/Detachment after model has been saved.

Reimplemented from OwnedSecurableItem.

Definition at line 299 of file Campaign.php.


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