EmailMessageRecipient Class Reference

Inheritance diagram for EmailMessageRecipient:
OwnedModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()

Static Public Member Functions

static getRecipientTypesArray ()
static renderNonEditableRecipientTypeStringContent ($type)
static getModuleClassName ()
static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()

Data Fields

const TYPE_TO = 1
const TYPE_CC = 2
const TYPE_BCC = 3

Static Protected Member Functions

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

Detailed Description

Model for storing recipient information about an email message. Stores specific toAddress and toName in case there is no specific 'person' the email is sending to. Also in case that 'person' changes their information, the integrity of what actual email address/name was used stays intact.

Definition at line 42 of file EmailMessageRecipient.php.


Member Function Documentation

__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 50 of file EmailMessageRecipient.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 83 of file EmailMessageRecipient.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 88 of file EmailMessageRecipient.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 123 of file EmailMessageRecipient.php.

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

Returns the display name for the model class.

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

Reimplemented from RedBeanModel.

Definition at line 133 of file EmailMessageRecipient.php.

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

Returns the display name for plural of the model class.

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

Reimplemented from RedBeanModel.

Definition at line 143 of file EmailMessageRecipient.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Wed Jul 26 07:10:24 2017