Documentation

Mail extends EntityBase
in package

Mail

Tags
copyright

Cloudrexx AG

author

Project Team SS4U info@cloudrexx.com

subpackage

module_calendar

Table of Contents

Properties

$actionId  : int
$contentHtml  : text
$contentText  : text
$eventLangId  : int
$id  : int
$isDefault  : int
$langId  : int
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$nestingCount  : int
Counts the nesting level of __call()
$recipients  : text
$status  : int
$stringRepresentationBlank  : bool
Whether blank string representations are valid
$stringRepresentationFields  : array<string|int, mixed>
List of fields that should be available in the string representation
$stringRepresentationFormat  : string
Sprintf format for the string representation
$title  : string
$validators  : array<string|int, mixed>
Initialize this array as follows: array( 'columName' => Zend_Validate )
$virtual  : bool
Defines if an entity is virtual and therefore not persistable.

Methods

__call()  : mixed
Route methods like getName(), getType(), getDirectory(), etc.
__construct()  : mixed
Constructor
__get()  : mixed
This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
__toString()  : string
Returns this entity's identifying value
getActionId()  : int
Get actionId
getComponentController()  : SystemComponent
Returns the component controller for this component
getContentHtml()  : text
Get contentHtml
getContentText()  : text
Get contentText
getEventLangId()  : int
Get eventLangId
getId()  : int
Get id
getIsDefault()  : int
Get isDefault
getKeyAsString()  : string
Returns this entity's key
getLangId()  : int
Get langId
getRecipients()  : text
Get recipients
getStatus()  : int
Get status
getTitle()  : string
Get title
getTranslatedFieldValue()  : mixed
Returns the value of a translatable field using fallback mechanisms
initializeValidators()  : mixed
Set $this->validators
isVirtual()  : bool
Returns the virtuality of the entity
setActionId()  : mixed
Set actionId
setContentHtml()  : mixed
Set contentHtml
setContentText()  : mixed
Set contentText
setEventLangId()  : mixed
Set eventLangId
setIsDefault()  : mixed
Set isDefault
setLangId()  : mixed
Set langId
setRecipients()  : mixed
Set recipients
setStatus()  : mixed
Set status
setTitle()  : mixed
Set title
setVirtual()  : mixed
Set the virtuality of the entity
validate()  : mixed
getFallbackLocaleCodes()  : array<string|int, mixed>
Returns a list of all locale codes ordered by fallback order
getStringRepresentationBlank()  : bool
Whether blank string representations are valid
getStringRepresentationFields()  : array<string|int, mixed>
Returns a list of fields available in the string representation
getStringRepresentationFormat()  : string
Returns the sprintf() format for the string representation

Properties

$localeCodes

List of locale codes ordered by translation fallback order per Cx instance

protected static array<string|int, mixed> $localeCodes = array()

Array in the form: array(<instanceId> => array(<localeCode>, ...))

Tags
see
getFallbackLocaleCodes()

$nestingCount

Counts the nesting level of __call()

protected static int $nestingCount = 0

$stringRepresentationBlank

Whether blank string representations are valid

protected bool $stringRepresentationBlank = false

Whether blank string representations are valid

Tags
see
getStringRepresentationBlank()

$stringRepresentationFields

List of fields that should be available in the string representation

protected array<string|int, mixed> $stringRepresentationFields = array()

List of field names

Tags
see
getStringRepresentationFields()

$stringRepresentationFormat

Sprintf format for the string representation

protected string $stringRepresentationFormat = ''

Sprintf format string

Tags
see
getStringRepresentationFormat()

$validators

Initialize this array as follows: array( 'columName' => Zend_Validate )

protected array<string|int, mixed> $validators = array()

$virtual

Defines if an entity is virtual and therefore not persistable.

protected bool $virtual = false

Defaults to FALSE - not virtual.

Methods

__call()

Route methods like getName(), getType(), getDirectory(), etc.

public __call(string $methodName, array<string|int, mixed> $arguments) : mixed
Parameters
$methodName : string

Name of method to call

$arguments : array<string|int, mixed>

List of arguments for the method to call

Tags
throws
Exception

If __call() nesting level reaches 20

Return values
mixed —

Return value of the method to call

__construct()

Constructor

public __construct() : mixed

__get()

This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.

public __get(mixed $name) : mixed
Parameters
$name : mixed

__toString()

Returns this entity's identifying value

public __toString() : string

By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.

Return values
string —

Identifying value for this entity

getActionId()

Get actionId

public getActionId() : int
Return values
int —

$actionId

getContentHtml()

Get contentHtml

public getContentHtml() : text
Return values
text —

$contentHtml

getContentText()

Get contentText

public getContentText() : text
Return values
text —

$contentText

getEventLangId()

Get eventLangId

public getEventLangId() : int
Return values
int —

$eventLangId

getId()

Get id

public getId() : int
Return values
int —

$id

getIsDefault()

Get isDefault

public getIsDefault() : int
Return values
int —

$isDefault

getKeyAsString()

Returns this entity's key

public final getKeyAsString([string $separator = '/' ]) : string

If this entity has a composite key, the fields are separated by $separator.

Parameters
$separator : string = '/'

(optional) Separator for composite key fields, default "/"

Return values
string —

Entity key as string

getLangId()

Get langId

public getLangId() : int
Return values
int —

$langId

getRecipients()

Get recipients

public getRecipients() : text
Return values
text —

$recipients

getStatus()

Get status

public getStatus() : int
Return values
int —

$status

getTitle()

Get title

public getTitle() : string
Return values
string —

$title

getTranslatedFieldValue()

Returns the value of a translatable field using fallback mechanisms

public getTranslatedFieldValue(string $fieldName) : mixed

If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):

  • Current locale
  • Default locale
  • All other locales
Parameters
$fieldName : string

Name of a translatable field

initializeValidators()

Set $this->validators

public initializeValidators() : mixed

Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called

isVirtual()

Returns the virtuality of the entity

public isVirtual() : bool
Return values
bool —

TRUE if the entity is virtual, otherwise FALSE

setActionId()

Set actionId

public setActionId(int $actionId) : mixed
Parameters
$actionId : int

setContentHtml()

Set contentHtml

public setContentHtml(text $contentHtml) : mixed
Parameters
$contentHtml : text

setContentText()

Set contentText

public setContentText(text $contentText) : mixed
Parameters
$contentText : text

setEventLangId()

Set eventLangId

public setEventLangId(int $eventLangId) : mixed
Parameters
$eventLangId : int

setIsDefault()

Set isDefault

public setIsDefault(int $isDefault) : mixed
Parameters
$isDefault : int

setLangId()

Set langId

public setLangId(int $langId) : mixed
Parameters
$langId : int

setRecipients()

Set recipients

public setRecipients(text $recipients) : mixed
Parameters
$recipients : text

setStatus()

Set status

public setStatus(int $status) : mixed
Parameters
$status : int

setTitle()

Set title

public setTitle(string $title) : mixed
Parameters
$title : string

setVirtual()

Set the virtuality of the entity

public setVirtual(bool $virtual) : mixed
Parameters
$virtual : bool

TRUE to set the entity as virtual or otherwise to FALSE

getFallbackLocaleCodes()

Returns a list of all locale codes ordered by fallback order

protected getFallbackLocaleCodes() : array<string|int, mixed>
  • First entry is the current locale
  • Second entry is the default locale (if different from current, it's omitted otherwise)
  • Then all other locales follow (in no particular order)
Tags
todo

Order the array by the fallback order (same as in ContentManager)

Return values
array<string|int, mixed> —

List of locale codes

getStringRepresentationBlank()

Whether blank string representations are valid

protected getStringRepresentationBlank() : bool
Return values
bool —

Whether blank string representations are valid

getStringRepresentationFields()

Returns a list of fields available in the string representation

protected getStringRepresentationFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —

List of field names

getStringRepresentationFormat()

Returns the sprintf() format for the string representation

protected getStringRepresentationFormat() : string
Return values
string —

sprintf() format string


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results