\FAA\Obj\GenericEmailSetup

Summary

Methods

Properties

Constants

__construct()
Delete()
GetPath()
UpdateAttributeKey()
BasicMailData()
CarbonCopyReceivers()
Save()
Copy()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$keyregex

N/A

Properties

$keyregex

$keyregex :

Type

Methods

__construct()

__construct(string  $id = null,string  $language = null)

Email setup Construct a new email setup object

Construct a name based element object

Parameters

string	$id	The object name/id or null for new one
string	$language	The object language or null for raw one

Delete()

Delete(boolean  $skip = false): \FAA\Obj\Result

delete entity from file system and git repository this method can delete this content object from our local storage system

Parameters

boolean

$skip

Skip hooks on demand

Returns

\FAA\Obj\Result —

A default system result set

GetPath()

GetPath(): string

expose the storage path provide an interface to extract the current path of this object

Returns

string —

the object storage path

UpdateAttributeKey()

UpdateAttributeKey(Object  $attr,string  $data): \FAA\Obj\Result

Callback on update validate name This function is called when the primary identifyer is changed, is called from objecthandler->updateentity

Parameters

Object	$attr	The changed attribute
string	$data	The new attribute value

Returns

\FAA\Obj\Result —

A system result object

BasicMailData()

BasicMailData(string  $language = FAA_DEFAULT_LANGUAGE,boolean  $include_receiver = false,boolean  $default_subject = false): array

Convert to basic data for new email Take local values and generate the basic update patch data set for new emails

Parameters

string	$language	A language id
boolean	$include_receiver	Include th default receiver on the fly
boolean	$default_subject	Use the default subject

Returns

array —

The patch data

CarbonCopyReceivers()

CarbonCopyReceivers(): array

Get cc receivers Parse the local storage data and return the list of registered cc receivers.

Returns

array —

List of registered receivers

Save()

Save(boolean  $force_new_id = false): \FAA\Obj\Result

Helper function to disable fetching of ids for this kind of content

Parameters

boolean

$force_new_id

Returns

\FAA\Obj\Result

Copy()

Copy(string  $target = null): \FAA\Obj\Result

copy entity in file system and git repository this method can copy this content object in our local storage system to a new one

Parameters

string

$target

The target name

Returns

\FAA\Obj\Result —

A default system result set