EmailBox Class Reference

Inheritance diagram for EmailBox:
Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 isSpecialBox ()
 __toString ()
 isDeletable ()

Static Public Member Functions

static getByName ($name)
static resolveAndGetByName ($name)
static getModuleClassName ()
static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()

Data Fields

const NOTIFICATIONS_NAME = 'System Notifications'
const USER_DEFAULT_NAME = 'Default'
const AUTORESPONDERS_NAME = 'Autoresponders'
const CAMPAIGNS_NAME = 'Campaigns'

Protected Member Functions

 setSpecialBox ()

Static Protected Member Functions

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

Protected Attributes

 $isSpecialBox = false

Detailed Description

Model for storing email boxes.

Definition at line 40 of file EmailBox.php.


Member Function Documentation

static getByName ( name  )  [static]

Gets by name

Parameters:
string $name
Returns:
string

Reimplemented from Item.

Definition at line 52 of file EmailBox.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 165 of file EmailBox.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 179 of file EmailBox.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.

Definition at line 184 of file EmailBox.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 204 of file EmailBox.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 214 of file EmailBox.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 224 of file EmailBox.php.

isDeletable (  ) 

To be overridden by derived classes to prevent deletion.

Reimplemented from RedBeanModel.

Definition at line 229 of file EmailBox.php.


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