CampaignItem Class Reference

Inheritance diagram for CampaignItem:
OwnedModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 isQueued ()
 isSkipped ()
 isSent ()
 hasFailedToSend ()
 hasAtLeastOneOpenActivity ()
 hasAtLeastOneClickActivity ()
 hasAtLeastOneUnsubscribeActivity ()
 hasAtLeastOneBounceActivity ()

Static Public Member Functions

static getModuleClassName ()
static getDefaultMetadata ()
static isTypeDeletable ()
static canSaveMetadata ()
static getByProcessed ($processed, $pageSize=null)
static getByProcessedAndSendOnDateTime ($processed, $timestamp=null, $pageSize=null)
static getByProcessedAndStatusAndSendOnDateTime ($processed, $status, $timestamp=null, $pageSize=null)
static getByProcessedAndCampaignId ($processed, $campaignId, $pageSize=null)
static getByTypeAndCampaignId ($type, $campaignId, $pageSize=null, $countOnly=false)
static registerCampaignItemsByCampaign ($campaign, $contacts)
static addNewItem ($processed, $contact, $campaign)

Static Protected Member Functions

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

Detailed Description

Definition at line 37 of file CampaignItem.php.


Member Function Documentation

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

Returns the display name for the model class.

Returns:
dynamic label name based on module.

Reimplemented from RedBeanModel.

Definition at line 48 of file CampaignItem.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 57 of file CampaignItem.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 RedBeanModel.

Definition at line 62 of file CampaignItem.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 OwnedModel.

Definition at line 85 of file CampaignItem.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 90 of file CampaignItem.php.

static getByProcessed ( processed,
pageSize = null 
) [static]
Parameters:
int $processed
null|int $pageSize

Definition at line 99 of file CampaignItem.php.

static getByProcessedAndSendOnDateTime ( processed,
timestamp = null,
pageSize = null 
) [static]
Parameters:
int $processed
null $timestamp
null|int $pageSize

Definition at line 121 of file CampaignItem.php.

static getByProcessedAndCampaignId ( processed,
campaignId,
pageSize = null 
) [static]
Parameters:
int $processed
int $campaignId
null|int $pageSize

Definition at line 189 of file CampaignItem.php.

static getByTypeAndCampaignId ( type,
campaignId,
pageSize = null,
countOnly = false 
) [static]
Parameters:
int $type
int $campaignId
null|int $pageSize
null|bool $countOnly

Definition at line 219 of file CampaignItem.php.

isQueued (  ) 

Return true if the related email message in on the outbox folder

Returns:
bool

Definition at line 279 of file CampaignItem.php.

isSkipped (  ) 
Returns:
bool

Definition at line 292 of file CampaignItem.php.

isSent (  ) 

Return true if the email message has been sent

Returns:
bool

Definition at line 312 of file CampaignItem.php.

hasFailedToSend (  ) 
Returns:
bool

Definition at line 324 of file CampaignItem.php.

hasAtLeastOneOpenActivity (  ) 
Returns:
bool;

Definition at line 336 of file CampaignItem.php.

hasAtLeastOneClickActivity (  ) 
Returns:
bool;

Definition at line 355 of file CampaignItem.php.

hasAtLeastOneUnsubscribeActivity (  ) 
Returns:
bool;

Definition at line 374 of file CampaignItem.php.

hasAtLeastOneBounceActivity (  ) 
Returns:
bool;

Definition at line 393 of file CampaignItem.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Fri May 26 07:10:23 2017