EmailFolder Class Reference

Inheritance diagram for EmailFolder:
Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()
 beforeDelete ()

Static Public Member Functions

static getDefaultDraftName ()
static getDefaultInboxName ()
static getDefaultSentName ()
static getDefaultOutboxName ()
static getDefaultOutboxErrorName ()
static getDefaultOutboxFailureName ()
static getDefaultArchivedName ()
static getDefaultArchivedUnmatchedName ()
static getTranslatedFolderNameByType ($type)
static getByBoxAndType (EmailBox $box, $type)
static getModuleClassName ()
static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()

Data Fields

const TYPE_INBOX = 'Inbox'
const TYPE_SENT = 'Sent'
const TYPE_OUTBOX = 'Outbox'
const TYPE_DRAFT = 'Draft'
const TYPE_OUTBOX_ERROR = 'OutboxError'
const TYPE_OUTBOX_FAILURE = 'OutboxFailure'
const TYPE_ARCHIVED = 'Archived'
const TYPE_ARCHIVED_UNMATCHED = 'ArchivedUnmatched'

Static Protected Member Functions

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

Detailed Description

Model for storing email folders.

Definition at line 40 of file EmailFolder.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 175 of file EmailFolder.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 189 of file EmailFolder.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 194 of file EmailFolder.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 219 of file EmailFolder.php.

beforeDelete (  ) 

This method is invoked before deleting a record. The default implementation raises the onBeforeDelete event. You may override this method to do any preparation work for record deletion. Make sure you call the parent implementation so that the event is raised properly.

Returns:
boolean whether the record should be deleted. Defaults to true.

Reimplemented from RedBeanModel.

Definition at line 234 of file EmailFolder.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 248 of file EmailFolder.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 258 of file EmailFolder.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sat Oct 21 07:10:25 2017