Warning: mysql_connect(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /home/zurmoorg/public_html/z-header.php on line 8

Deprecated: mysql_connect(): The mysql extension is deprecated and will be removed in the future: use mysqli or PDO instead in /home/zurmoorg/public_html/z-header.php on line 8

CampaignItem Class Reference

Inheritance diagram for CampaignItem:
OwnedModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 isQueued ()
 isSkipped ()
 isSent ()
 hasFailedToSend ()
 hasAtLeastOneOpenActivity ()
 hasAtLeastOneClickActivity ()
 hasAtLeastOneUnsubscribeActivity ()
 hasAtLeastOneBounceActivity ()
 hasAtLeastOneEventActivity ($eventType)

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 getAllContactsFromCampaignItemBasedOnItemActivity ($campaignId, $offset, $pageSize, $getNotViewedItem=false, $getNotClickedItems=false, $getOpenedItems=false, $getClickedItems=false)
static getNotViewedContactIds ($campaignId, $offset, $pageSize)
static getCountOfNotViewedContactIds ($campaignId)
static getNotClickedOrUnsubscribedOrSpamContactIds ($campaignId, $offset, $pageSize)
static getCountOfNotClickedOrUnsubscribedOrSpamContactIds ($campaignId)
static getContactIdsFromCampaignItemsByActivityTypeAndCampaign ($type, $campaignId, $offset, $pageSize)
static getCountOfCampaignItemsByActivityTypeAndCampaign ($type, $campaignId)

Protected Member Functions

 afterDelete ()

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 92 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 97 of file CampaignItem.php.

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

Definition at line 106 of file CampaignItem.php.

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

Definition at line 128 of file CampaignItem.php.

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

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

isQueued (  ) 

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

Returns:
bool

Definition at line 259 of file CampaignItem.php.

isSkipped (  ) 
Returns:
bool

Definition at line 272 of file CampaignItem.php.

isSent (  ) 

Return true if the email message has been sent

Returns:
bool

Definition at line 292 of file CampaignItem.php.

hasFailedToSend (  ) 
Returns:
bool

Definition at line 304 of file CampaignItem.php.

hasAtLeastOneOpenActivity (  ) 
Returns:
bool;

Definition at line 316 of file CampaignItem.php.

hasAtLeastOneClickActivity (  ) 
Returns:
bool;

Definition at line 324 of file CampaignItem.php.

hasAtLeastOneUnsubscribeActivity (  ) 
Returns:
bool;

Definition at line 332 of file CampaignItem.php.

hasAtLeastOneBounceActivity (  ) 
Returns:
bool;

Definition at line 340 of file CampaignItem.php.

hasAtLeastOneEventActivity ( eventType  ) 
Returns:
bool;

Definition at line 348 of file CampaignItem.php.

afterDelete (  )  [protected]

This method is invoked after deleting a record. The default implementation raises the onAfterDelete event. You may override this method to do postprocessing after the record is deleted. Make sure you call the parent implementation so that the event is raised properly.

Reimplemented from RedBeanModel.

Definition at line 364 of file CampaignItem.php.

static getNotViewedContactIds ( campaignId,
offset,
pageSize 
) [static]

Get not viewed contacts from campaigns.

Parameters:
int $campaignId
int $offset
int $pageSize
Returns:
array

Definition at line 408 of file CampaignItem.php.

static getCountOfNotViewedContactIds ( campaignId  )  [static]

Get count of not viewed items.

Parameters:
int $campaignId
Returns:
int

Definition at line 431 of file CampaignItem.php.

static getNotClickedOrUnsubscribedOrSpamContactIds ( campaignId,
offset,
pageSize 
) [static]

Get contacts from campaign items that are not clicked, but do not return those that are marked as spam, unsubscribed, or hard bounced

Parameters:
int $campaignId
int offset
int pageSize
Returns:
array

Definition at line 451 of file CampaignItem.php.

static getCountOfNotClickedOrUnsubscribedOrSpamContactIds ( campaignId  )  [static]

Get count of contacts that are not clicked, but do not return those that are marked as spam, unsubscribed, or hard bounced

Parameters:
int $campaignId
Returns:
int

Definition at line 485 of file CampaignItem.php.

static getContactIdsFromCampaignItemsByActivityTypeAndCampaign ( type,
campaignId,
offset,
pageSize 
) [static]

Get distinct contact ids by activity type and campaign

Parameters:
$type 
int $campaignId
$offset 
$pageSize 
Returns:
An

Definition at line 518 of file CampaignItem.php.

static getCountOfCampaignItemsByActivityTypeAndCampaign ( type,
campaignId 
) [static]

Get number of distinct contacts by activity type and campaign

Parameters:
$type 
int $campaignId
Returns:
string

Definition at line 543 of file CampaignItem.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sun Mar 24 07:10:45 2019

Warning: mysql_connect(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /home/zurmoorg/public_html/z-footer.php on line 8

Deprecated: mysql_connect(): The mysql extension is deprecated and will be removed in the future: use mysqli or PDO instead in /home/zurmoorg/public_html/z-footer.php on line 8