MarketingList Class Reference

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

Public Member Functions

 __toString ()
 addNewMember ($contactId, $unsubscribed=false, $contact=null)
 memberAlreadyExists ($contactId)

Static Public Member Functions

static getByName ($name)
static getModuleClassName ()
static canSaveMetadata ()
static isTypeDeletable ()
static getDefaultMetadata ()
static hasReadPermissionsOptimization ()
static getGamificationRulesType ()
static getByAnyoneCanSubscribe ($anyoneCanSubscribe, $pageSize=null)
static getByUnsubscribedAndAnyoneCanSubscribe ($contactId, $unsubscribed=0, $anyoneCanSubscribe=1, $pageSize=null)

Static Protected Member Functions

static getLabel ($language=null)
static getPluralLabel ($language=null)
static getIdsByAnyOneCanSubscribe ($anyoneCanSubscribe, $pageSize=null)
static getIdsByUnsubscribed ($contactId, $unsubscribed=0, $pageSize=null)

Detailed Description

Definition at line 37 of file MarketingList.php.


Member Function Documentation

static getByName ( name  )  [static]

Gets by name

Parameters:
string $name
Returns:
string

Reimplemented from Item.

Definition at line 39 of file MarketingList.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 49 of file MarketingList.php.

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

Returns the display name for the model class. Defaults to the module label. Override if the model label is not the module label. Make sure to return a translated label. Also provides fall back in moduleClassName is null.

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

Reimplemented from RedBeanModel.

Definition at line 65 of file MarketingList.php.

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

Returns the display name for plural of the model class.

Returns:
dynamic label name based on module.

Reimplemented from RedBeanModel.

Definition at line 74 of file MarketingList.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 79 of file MarketingList.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 84 of file MarketingList.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 89 of file MarketingList.php.

static hasReadPermissionsOptimization (  )  [static]

Override on any models you want to utilize ReadPermissionsOptimization

Reimplemented from SecurableItem.

Definition at line 127 of file MarketingList.php.

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

Reimplemented from Item.

Definition at line 132 of file MarketingList.php.


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