EmailMessageActivity Class Reference

Inheritance diagram for EmailMessageActivity:
Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent AutoresponderItemActivity CampaignItemActivity

Public Member Functions

 beforeSave ()
 __toString ()

Static Public Member Functions

static getTypesArray ()
static getModuleClassName ()
static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()
static getByType ($type, $pageSize=null)
static getSearchAttributeDataByTypeAndPersonIdAndUrl ($type, $personId, $url=null)
static getByTypeAndModelIdAndPersonIdAndUrl ($type, $modelId, $personId, $url=null, $sortBy= 'latestDateTime', $pageSize=null, $countOnly=false)
static createNewActivity ($type, $modelId, $personId, $url=null, $sourceIP=null, $relatedModel=null)

Data Fields

const TYPE_OPEN = 1
const TYPE_CLICK = 2
const TYPE_UNSUBSCRIBE = 3
const TYPE_BOUNCE = 4
const TYPE_SKIP = 5

Static Protected Member Functions

static createNewOpenActivityForFirstClickTrackingActivity ($type, $personId, $relatedModel, $sourceIP)
static shouldCreateOpenActivityForTrackingActivity ($type, $personId, $modelId)
static getLabel ($language=null)
static getPluralLabel ($language=null)
static getRelationName ()
static getRelatedModelClassName ()
static getIndexesDefinition ()

Detailed Description

Model for storing an email message item activity.

Definition at line 40 of file EmailMessageActivity.php.


Member Function Documentation

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 68 of file EmailMessageActivity.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 Item.

Reimplemented in AutoresponderItemActivity, and CampaignItemActivity.

Definition at line 73 of file EmailMessageActivity.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 Item.

Definition at line 105 of file EmailMessageActivity.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.

Reimplemented in AutoresponderItemActivity, and CampaignItemActivity.

Definition at line 273 of file EmailMessageActivity.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.

Reimplemented in AutoresponderItemActivity, and CampaignItemActivity.

Definition at line 282 of file EmailMessageActivity.php.

beforeSave (  ) 

Special handling of the import scenario. When you are importing a model, you can potentially set the created/modified user/datetime which is normally not allowed since they are read-only attributes. This logic helps to allow for this special use case.

See also:
RedBeanModel::beforeSave()

Reimplemented from Item.

Definition at line 287 of file EmailMessageActivity.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 297 of file EmailMessageActivity.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon Nov 20 07:10:24 2017