Docs For Class CMS_object

CMS_object_email

Description

Class CMS_object_email

represent an email object

author: Jérémie Bryon <jeremie.bryon@ws-interactive.fr> &
author: Sébastien Pauchet <sebastien.pauchet@ws-interactive.fr>

Located in /automne/classes/modules/polymod/objects/object_email.php (line 29)

CMS_grandFather
   |
   --CMS_object_common
      |
      --CMS_object_email

Class Constant Summary

MESSAGE_OBJECT_EMAIL_ACTIVE = 357

MESSAGE_OBJECT_EMAIL_DESCRIPTION = 337

MESSAGE_OBJECT_EMAIL_INACTIVE = 358

MESSAGE_OBJECT_EMAIL_LABEL = 336

MESSAGE_OBJECT_EMAIL_LAST_SENDING = 355

MESSAGE_OBJECT_EMAIL_MESSAGES_SENT = 427

MESSAGE_OBJECT_EMAIL_NEVER = 356

MESSAGE_OBJECT_EMAIL_PARAMETER_BODY = 339

MESSAGE_OBJECT_EMAIL_PARAMETER_BODY_HTML = 354

MESSAGE_OBJECT_EMAIL_PARAMETER_BODY_PAGE = 353

MESSAGE_OBJECT_EMAIL_PARAMETER_DEFAULT = 609

MESSAGE_OBJECT_EMAIL_PARAMETER_DEFAULT_DESC = 610

MESSAGE_OBJECT_EMAIL_PARAMETER_DISABLEGROUPS = 315

MESSAGE_OBJECT_EMAIL_PARAMETER_DISABLEUSERS = 314

MESSAGE_OBJECT_EMAIL_PARAMETER_EMAIL_FROM = 346

MESSAGE_OBJECT_EMAIL_PARAMETER_EMAIL_FROM_DESC = 347

MESSAGE_OBJECT_EMAIL_PARAMETER_EXPLANATION = 352

MESSAGE_OBJECT_EMAIL_PARAMETER_GROUPS_LEFT_TITLE = 318

MESSAGE_OBJECT_EMAIL_PARAMETER_GROUPS_RIGHT_TITLE = 319

MESSAGE_OBJECT_EMAIL_PARAMETER_INCLUDE_EXCLUDE = 320

MESSAGE_OBJECT_EMAIL_PARAMETER_INCLUDE_EXCLUDE_DESCRIPTION = 388

MESSAGE_OBJECT_EMAIL_PARAMETER_INCLUDE_FILES = 344

MESSAGE_OBJECT_EMAIL_PARAMETER_INCLUDE_FILES_DESC = 345

MESSAGE_OBJECT_EMAIL_PARAMETER_SEND_EMAIL = 340

MESSAGE_OBJECT_EMAIL_PARAMETER_SEND_EMAIL_DESC = 343

MESSAGE_OBJECT_EMAIL_PARAMETER_SEND_EMAIL_ON = 350

MESSAGE_OBJECT_EMAIL_PARAMETER_SEND_EMAIL_ON_DESC = 351

MESSAGE_OBJECT_EMAIL_PARAMETER_SEND_EMAIL_ON_SYSTEM_EVENT = 349

MESSAGE_OBJECT_EMAIL_PARAMETER_SEND_EMAIL_ON_VALIDATION = 348

MESSAGE_OBJECT_EMAIL_PARAMETER_SUBJECT = 338

MESSAGE_OBJECT_EMAIL_PARAMETER_USERGROUPFIELD = 583

MESSAGE_OBJECT_EMAIL_PARAMETER_USERGROUPFIELD_DESC = 584

MESSAGE_OBJECT_EMAIL_PARAMETER_USERS_LEFT_TITLE = 316

MESSAGE_OBJECT_EMAIL_PARAMETER_USERS_RIGHT_TITLE = 317

MESSAGE_OBJECT_EMAIL_TASK_PREPARE_EMAIL_NOTIFICATION = 359

MESSAGE_OBJECT_EMAIL_TASK_SEND_EMAIL_NOTIFICATION = 360

OBJECT_EMAIL_PARAMETER_SEND_ON_SYSTEM_EVENT = 2

OBJECT_EMAIL_PARAMETER_SEND_ON_VALIDATION = 1

Method Summary

boolean afterValidation (integer $validationResult, CMS_poly_object &$validatedObject)

array asArray ()

boolean checkMandatory (array $values, string $prefixName)

string getHTMLAdmin ( $fieldID, $language, string $prefixName, integer $fieldID,, CMS_language $language,)

string getHTMLSubFieldsParametersDisableGroups ( $language, $prefixName)

string getHTMLSubFieldsParametersDisableUsers ( $language, $prefixName)

void getHTMLSubFieldsParametersEmailBody ( $language, $prefixName)

string getHTMLSubFieldsParametersEmailSubject ( $language, $prefixName)

void getHTMLSubFieldsParametersSendEmailOn ( $language, $prefixName)

string getHTMLSubFieldsParametersUsersGroupsField ( $language, $prefixName)

string getInput ( $fieldID, multidimentionnal $language, $inputParams, array $values)

string getLabel ()

multidimentionnal getValue (string $name, [string $parameters = ''])

void __construct ([array $datas = array()], CMS_object_field &$field, [boolean $public = false])

string scriptInfo (array $parameters)

Boolean scriptTask (array $parameters)

array, treatParams (array $post, string $prefix)

void _getFieldsFiles ( $item, &$files)

array _getRecipients ( $objectID)

Methods

afterValidation (line 764)

Current object pass the validation process

access: public

boolean afterValidation (integer $validationResult, CMS_poly_object &$validatedObject)

integer $validationResult: : the validation status
CMS_poly_object &$validatedObject: : the reference of the object currently validated

asArray (line 1076)

Get field parameters as an array structure used for export

return: : the object array structure
access: public

array asArray ()

Redefinition of:

CMS_object_common::asArray(): Get field parameters as an array structure used for export

checkMandatory (line 236)

check object Mandatories Values

return: true on success, false on failure
access: public

boolean checkMandatory (array $values, string $prefixName)

array $values: : the POST result values
string $prefixName: prefixname : the prefix used for post names

Redefinition of:

CMS_object_common::checkMandatory(): check object Mandatories Values

getHTMLAdmin (line 627)

get HTML admin (used to enter object values in admin)

return: : the html admin
access: public

string getHTMLAdmin ( $fieldID, $language, string $prefixName, integer $fieldID,, CMS_language $language,)

integer $fieldID,: the current field id (only for poly object compatibility)
CMS_language $language,: the current admin language
string $prefixName: prefixname : the prefix to use for post names
$fieldID
$language

Redefinition of:

CMS_object_common::getHTMLAdmin(): get HTML admin (used to enter object values in admin)

getHTMLSubFieldsParametersDisableGroups (line 386)

get HTML admin subfields parameters (used to enter object categories parameters values in admin)

return: : the html admin
access: public

string getHTMLSubFieldsParametersDisableGroups ( $language, $prefixName)

$language
$prefixName

getHTMLSubFieldsParametersDisableUsers (line 343)

get HTML admin subfields parameters (used to enter object categories parameters values in admin)

return: : the html admin
access: public

string getHTMLSubFieldsParametersDisableUsers ( $language, $prefixName)

$language
$prefixName

getHTMLSubFieldsParametersEmailBody (line 484)

void getHTMLSubFieldsParametersEmailBody ( $language, $prefixName)

$language
$prefixName

getHTMLSubFieldsParametersEmailSubject (line 469)

get HTML admin subfields parameters (used to enter object categories parameters values in admin)

return: : the html admin
access: public

string getHTMLSubFieldsParametersEmailSubject ( $language, $prefixName)

$language
$prefixName

getHTMLSubFieldsParametersSendEmailOn (line 572)

void getHTMLSubFieldsParametersSendEmailOn ( $language, $prefixName)

$language
$prefixName

getHTMLSubFieldsParametersUsersGroupsField (line 428)

get HTML admin subfields parameters

return: : the html admin
access: public

string getHTMLSubFieldsParametersUsersGroupsField ( $language, $prefixName)

$language
$prefixName

getInput (line 711)

Return the needed form field tag for current object field

return: : the form field HTML tag
access: public

string getInput ( $fieldID, multidimentionnal $language, $inputParams, array $values)

array $values: : parameters values array(parameterName => parameterValue) in : id : the form field id to set
multidimentionnal $language: array $tags : xml2Array content of atm-function tag
$fieldID
$inputParams

Redefinition of:

CMS_object_common::getInput(): Return the needed form field tag for current object field

getLabel (line 246)

get object label : by default, the first subField value (used to designate this object in lists)

return: : the label
access: public

string getLabel ()

Redefinition of:

CMS_object_common::getLabel(): get object label : by default, the first subField value (used to designate this object in lists)

getValue (line 604)

get an object value

return: array : the object values structure
access: public

multidimentionnal getValue (string $name, [string $parameters = ''])

string $name: : the name of the value to get
string $parameters: (optional) : parameters for the value to get

Redefinition of:

CMS_object_common::getValue(): get an object value

Constructor __construct (line 223)

Constructor.

initialize object.

access: public

void __construct ([array $datas = array()], CMS_object_field &$field, [boolean $public = false])

array $datas: DB object values : array(integer "subFieldID" => mixed)
boolean $public: values are public or edited ? (default is edited)
CMS_object_field &$field: reference

Redefinition of:

CMS_object_common::__construct(): Constructor.

scriptInfo (line 1059)

Module script info : get infos for a given script parameters

return: : HTML scripts infos
access: public

string scriptInfo (array $parameters)

array $parameters: the task parameters task : string task to execute module : string module codename for the task uid : string module uid

scriptTask (line 866)

Module script task

return: true/false
access: public

Boolean scriptTask (array $parameters)

array $parameters: the task parameters task : string task to execute object : string module codename for the task field : string module uid ... : optional field relative parameters

treatParams (line 281)

treat all params then return array of values treated or false if error

return: the treated datas
access: public

array, treatParams (array $post, string $prefix)

array $post: the posted datas
string $prefix: the prefix for datas name

Redefinition of:

CMS_object_common::treatParams(): treat all params then return array of values treated or false if error

_getFieldsFiles (line 1018)

void _getFieldsFiles ( $item, &$files)

$item
&$files

_getRecipients (line 785)

Get all selected recipients for the field

return: of usersIds which are recipients of the notification
access: public

array _getRecipients ( $objectID)

$objectID

Inherited Methods

Inherited From CMS_object_common

CMS_object_common::__construct()
CMS_object_common::asArray()
CMS_object_common::checkMandatory()
CMS_object_common::getDescription()
CMS_object_common::getFieldDescription()
CMS_object_common::getFieldLabel()
CMS_object_common::getFieldOrderSQL()
CMS_object_common::getFieldSearchSQL()
CMS_object_common::getHTMLAdmin()
CMS_object_common::getHTMLDescription()
CMS_object_common::getHTMLSubFieldsParameters()
CMS_object_common::getInput()
CMS_object_common::getLabel()
CMS_object_common::getLabelsStructure()
CMS_object_common::getObjectLabel()
CMS_object_common::getParamsValues()
CMS_object_common::getParamValue()
CMS_object_common::getSoapValues()
CMS_object_common::getStructure()
CMS_object_common::getSubFieldParameters()
CMS_object_common::getSubFieldsDefinition()
CMS_object_common::getValue()
CMS_object_common::hasParameters()
CMS_object_common::serializeHTMLParameters()
CMS_object_common::setParamValue()
CMS_object_common::setSoapValues()
CMS_object_common::setSubFieldsDefinition()
CMS_object_common::setValues()
CMS_object_common::treatParams()
CMS_object_common::writeToPersistence()

Inherited From CMS_grandFather

CMS_grandFather::autoload()
CMS_grandFather::hasError()
CMS_grandFather::log()
CMS_grandFather::PHPErrorHandler()
CMS_grandFather::raiseError()
CMS_grandFather::setDebug()
CMS_grandFather::setLog()
CMS_grandFather::_raiseError()
CMS_grandFather::__call()

Class Constants

MESSAGE_OBJECT_EMAIL_ACTIVE = 357 (line 53)

MESSAGE_OBJECT_EMAIL_DESCRIPTION = 337 (line 35)

MESSAGE_OBJECT_EMAIL_INACTIVE = 358 (line 54)

MESSAGE_OBJECT_EMAIL_LABEL = 336 (line 34)

Polymod Messages

MESSAGE_OBJECT_EMAIL_LAST_SENDING = 355 (line 51)

MESSAGE_OBJECT_EMAIL_MESSAGES_SENT = 427 (line 65)

MESSAGE_OBJECT_EMAIL_NEVER = 356 (line 52)

MESSAGE_OBJECT_EMAIL_PARAMETER_BODY = 339 (line 37)

MESSAGE_OBJECT_EMAIL_PARAMETER_BODY_HTML = 354 (line 50)

MESSAGE_OBJECT_EMAIL_PARAMETER_BODY_PAGE = 353 (line 49)

MESSAGE_OBJECT_EMAIL_PARAMETER_DEFAULT = 609 (line 68)

MESSAGE_OBJECT_EMAIL_PARAMETER_DEFAULT_DESC = 610 (line 69)

MESSAGE_OBJECT_EMAIL_PARAMETER_DISABLEGROUPS = 315 (line 60)

MESSAGE_OBJECT_EMAIL_PARAMETER_DISABLEUSERS = 314 (line 59)

MESSAGE_OBJECT_EMAIL_PARAMETER_EMAIL_FROM = 346 (line 42)

MESSAGE_OBJECT_EMAIL_PARAMETER_EMAIL_FROM_DESC = 347 (line 43)

MESSAGE_OBJECT_EMAIL_PARAMETER_EXPLANATION = 352 (line 48)

MESSAGE_OBJECT_EMAIL_PARAMETER_GROUPS_LEFT_TITLE = 318 (line 63)

MESSAGE_OBJECT_EMAIL_PARAMETER_GROUPS_RIGHT_TITLE = 319 (line 64)

MESSAGE_OBJECT_EMAIL_PARAMETER_INCLUDE_EXCLUDE = 320 (line 57)

MESSAGE_OBJECT_EMAIL_PARAMETER_INCLUDE_EXCLUDE_DESCRIPTION = 388 (line 58)

MESSAGE_OBJECT_EMAIL_PARAMETER_INCLUDE_FILES = 344 (line 40)

MESSAGE_OBJECT_EMAIL_PARAMETER_INCLUDE_FILES_DESC = 345 (line 41)

MESSAGE_OBJECT_EMAIL_PARAMETER_SEND_EMAIL = 340 (line 38)

MESSAGE_OBJECT_EMAIL_PARAMETER_SEND_EMAIL_DESC = 343 (line 39)

MESSAGE_OBJECT_EMAIL_PARAMETER_SEND_EMAIL_ON = 350 (line 46)

MESSAGE_OBJECT_EMAIL_PARAMETER_SEND_EMAIL_ON_DESC = 351 (line 47)

MESSAGE_OBJECT_EMAIL_PARAMETER_SEND_EMAIL_ON_SYSTEM_EVENT = 349 (line 45)

MESSAGE_OBJECT_EMAIL_PARAMETER_SEND_EMAIL_ON_VALIDATION = 348 (line 44)

MESSAGE_OBJECT_EMAIL_PARAMETER_SUBJECT = 338 (line 36)

MESSAGE_OBJECT_EMAIL_PARAMETER_USERGROUPFIELD = 583 (line 66)

MESSAGE_OBJECT_EMAIL_PARAMETER_USERGROUPFIELD_DESC = 584 (line 67)

MESSAGE_OBJECT_EMAIL_PARAMETER_USERS_LEFT_TITLE = 316 (line 61)

MESSAGE_OBJECT_EMAIL_PARAMETER_USERS_RIGHT_TITLE = 317 (line 62)

MESSAGE_OBJECT_EMAIL_TASK_PREPARE_EMAIL_NOTIFICATION = 359 (line 55)

MESSAGE_OBJECT_EMAIL_TASK_SEND_EMAIL_NOTIFICATION = 360 (line 56)

OBJECT_EMAIL_PARAMETER_SEND_ON_SYSTEM_EVENT = 2 (line 72)

OBJECT_EMAIL_PARAMETER_SEND_ON_VALIDATION = 1 (line 71)

Inherited Constants

Inherited from CMS_object_common

CMS_object_common::MESSAGE_FIELD_NO
CMS_object_common::MESSAGE_FIELD_YES
CMS_object_common::MESSAGE_OBJECT_COMMON_FIELDID_DESCRIPTION
CMS_object_common::MESSAGE_OBJECT_COMMON_FIELDNAME_DESCRIPTION
CMS_object_common::MESSAGE_OBJECT_COMMON_FIELD_DESC_DESCRIPTION
CMS_object_common::MESSAGE_OBJECT_COMMON_LABEL_DESCRIPTION
CMS_object_common::MESSAGE_OBJECT_COMMON_REQUIRED_DESCRIPTION
CMS_object_common::MESSAGE_OBJECT_COMMON_VALUE_DESCRIPTION
CMS_object_common::MESSAGE_UNKNOWN_OBJECT_DESCRIPTION
CMS_object_common::MESSAGE_UNKNOWN_OBJECT_LABEL

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL

Documentation generated on Wed, 15 Feb 2012 15:33:44 +0100 by phpDocumentor 1.4.3