User_Setting_Mail
in package
User Settings Mail Object
Tags
Table of Contents
Properties
- $arrAttributes : mixed
- $arrAvailableFormats : mixed
- $arrAvailableTypes : mixed
- $arrLoadedMails : mixed
- $body_html : mixed
- $body_text : mixed
- $EOF : mixed
- $error_msg : string
- Contains the message if an error occurs
- $format : mixed
- $lang_id : mixed
- $languageEOF : mixed
- $sender_mail : mixed
- $sender_name : mixed
- $subject : mixed
- $type : mixed
Methods
- __construct() : mixed
- clean() : mixed
- Clean data
- delete() : mixed
- first() : mixed
- Load first mail
- firstLanguage() : mixed
- getBodyHtml() : mixed
- getBodyText() : mixed
- getErrorMsg() : mixed
- getFormat() : mixed
- getFormats() : mixed
- getLangId() : mixed
- getPlaceholders() : mixed
- getSenderMail() : mixed
- getSenderName() : mixed
- getSubject() : mixed
- getType() : mixed
- getTypeDescription() : mixed
- isRemovable() : mixed
- isValidBody() : mixed
- load() : unknown
- Load e-mail template
- loadMails() : mixed
- next() : mixed
- Load next mail
- nextLanguage() : mixed
- setBodyHtml() : mixed
- setBodyText() : mixed
- setFormat() : mixed
- setLangId() : mixed
- setSenderMail() : mixed
- setSenderName() : mixed
- setSubject() : mixed
- setType() : mixed
- store() : mixed
- validateBody() : mixed
- validateFormat() : mixed
- validateSenderMail() : mixed
- validateSenderName() : mixed
- validateType() : mixed
Properties
$arrAttributes
public
mixed
$arrAttributes
= array('type' => 'string', 'lang_id' => 'int', 'sender_mail' => 'string', 'sender_name' => 'string', 'subject' => 'string', 'format' => 'string', 'body_text' => 'string', 'body_html' => 'string')
Tags
$arrAvailableFormats
public
mixed
$arrAvailableFormats
= array('text' => 'TXT_ACCESS_ONLY_TEXT', 'html' => 'TXT_ACCESS_HTML_UC', 'multipart' => 'TXT_ACCESS_MULTIPART')
$arrAvailableTypes
public
mixed
$arrAvailableTypes
= array('reg_confirm' => array('title' => 'TXT_ACCESS_REGISTER_CONFIRMATION', 'placeholders' => array('[[USERNAME]]' => 'TXT_ACCESS_USERNAME_DESC', '[[HOST]]' => 'TXT_ACCESS_HOST_DESC', '[[ACTIVATION_LINK]]' => 'TXT_ACCESS_ACTIVATION_LINK_DESC', '[[HOST_LINK]]' => 'TXT_ACCESS_HOST_LINK_DESC', '[[SENDER]]' => 'TXT_ACCESS_SENDER_DESC', '[[YEAR]]' => 'TXT_ACCESS_YEAR_DESC'), 'required' => array('[[ACTIVATION_LINK]]')), 'reset_pw' => array('title' => 'TXT_ACCESS_RESET_PASSWORD', 'placeholders' => array('[[USERNAME]]' => 'TXT_ACCESS_USERNAME_DESC', '[[URL]]' => 'TXT_ACCESS_RESET_PW_URL_DESC', '[[SENDER]]' => 'TXT_ACCESS_SENDER_DESC', '[[YEAR]]' => 'TXT_ACCESS_YEAR_DESC'), 'required' => array('[[URL]]')), 'user_activated' => array('title' => 'TXT_ACCESS_USER_ACCOUNT_ACTIVATED', 'placeholders' => array('[[USERNAME]]' => 'TXT_ACCESS_USERNAME_DESC', '[[HOST]]' => 'TXT_ACCESS_HOST_DESC', '[[SENDER]]' => 'TXT_ACCESS_SENDER_DESC', '[[YEAR]]' => 'TXT_ACCESS_YEAR_DESC'), 'required' => array()), 'user_deactivated' => array('title' => 'TXT_ACCESS_USER_ACCOUNT_DEACTIVATED', 'placeholders' => array('[[USERNAME]]' => 'TXT_ACCESS_USERNAME_DESC', '[[HOST]]' => 'TXT_ACCESS_HOST_DESC', '[[SENDER]]' => 'TXT_ACCESS_SENDER_DESC', '[[YEAR]]' => 'TXT_ACCESS_YEAR_DESC'), 'required' => array()), 'new_user' => array('title' => 'TXT_ACCESS_NEW_USER_REGISTRATION', 'placeholders' => array('[[USERNAME]]' => 'TXT_ACCESS_USERNAME_DESC', '[[LINK]]' => 'TXT_ACCESS_MANAGE_USER_LINK_DESC', '[[SENDER]]' => 'TXT_ACCESS_SENDER_DESC', '[[YEAR]]' => 'TXT_ACCESS_YEAR_DESC'), 'required' => array('[[USERNAME]]')), 'user_account_invitation' => array('title' => 'TXT_ACCESS_USER_ACCOUNT_INVITATION', 'placeholders' => array('[[FIRSTNAME]]' => 'TXT_ACCESS_FIRSTNAME', '[[LASTNAME]]' => 'TXT_ACCESS_LASTNAME', '[[WEBSITE]]' => 'TXT_SETTINGS_DOMAIN_URL', '[[LINK]]' => 'TXT_ACCESS_LINK_DESC', '[[EMAIL]]' => 'TXT_ACCESS_EMAIL_DESC', '[[PASSWORD]]' => 'TXT_ACCESS_PASSWORD', '[[SENDER]]' => 'TXT_ACCESS_SENDER_DESC', '[[YEAR]]' => 'TXT_ACCESS_YEAR_DESC'), 'required' => array()), 'signup_notification' => array('title' => 'TXT_ACCESS_SIGNUP_NOTIFICATION', 'placeholders' => array('[HOST]' => 'TXT_ACCESS_HOST_DESC', '[USER_ID]' => 'TXT_ACCESS_USER_ID_SIGNUP', '[PROFILE_NAME]' => 'TXT_ACCESS_PROFILE_NAME_SIGNUP_DESC', '[PROFILE_DATA]' => 'TXT_ACCESS_PROFILE_DATA_SIGNUP_DESC', '[[PROFILE_ATTRIBUTE_LIST]<br />
[PROFILE_ATTRIBUTE_NAME]<br />
[PROFILE_ATTRIBUTE_OLD_VALUE]<br />
[PROFILE_ATTRIBUTE_VALUE]<br />
[PROFILE_ATTRIBUTE_LIST]]' => 'TXT_ACCESS_PROFILE_ATTRIBUTE_LIST_SIGNUP_DESC', '[YEAR]' => 'TXT_ACCESS_YEAR_DESC'), 'required' => array()), 'user_profile_modification' => array('title' => 'TXT_ACCESS_USER_PROFILE_MODIFICATION', 'placeholders' => array('[HOST]' => 'TXT_ACCESS_HOST_DESC', '[USER_ID]' => 'TXT_ACCESS_USER_ID', '[PROFILE_NAME]' => 'TXT_ACCESS_PROFILE_NAME_DESC', '[PROFILE_DATA]' => 'TXT_ACCESS_PROFILE_DATA_DESC', '[[PROFILE_ATTRIBUTE_LIST]<br />
[[PROFILE_ATTRIBUTE_CHANGED]<br />
[PROFILE_ATTRIBUTE_NAME]<br />
[PROFILE_ATTRIBUTE_OLD_VALUE]<br />
[PROFILE_ATTRIBUTE_VALUE]<br />
[PROFILE_ATTRIBUTE_CHANGED]]<br />
[PROFILE_ATTRIBUTE_LIST]]' => 'TXT_ACCESS_PROFILE_ATTRIBUTE_LIST_DESC', '[YEAR]' => 'TXT_ACCESS_YEAR_DESC'), 'required' => array()))
$arrLoadedMails
public
mixed
$arrLoadedMails
= array()
$body_html
public
mixed
$body_html
$body_text
public
mixed
$body_text
$EOF
public
mixed
$EOF
Tags
$error_msg
Contains the message if an error occurs
public
string
$error_msg
Tags
$format
public
mixed
$format
$lang_id
public
mixed
$lang_id
$languageEOF
public
mixed
$languageEOF
$sender_mail
public
mixed
$sender_mail
$sender_name
public
mixed
$sender_name
$subject
public
mixed
$subject
$type
public
mixed
$type
Methods
__construct()
public
__construct() : mixed
clean()
Clean data
public
clean() : mixed
Reset all data for a new mail template.
delete()
public
delete() : mixed
first()
Load first mail
public
first() : mixed
firstLanguage()
public
firstLanguage() : mixed
getBodyHtml()
public
getBodyHtml() : mixed
getBodyText()
public
getBodyText() : mixed
getErrorMsg()
public
getErrorMsg() : mixed
getFormat()
public
getFormat() : mixed
getFormats()
public
getFormats() : mixed
getLangId()
public
getLangId() : mixed
getPlaceholders()
public
getPlaceholders() : mixed
getSenderMail()
public
getSenderMail() : mixed
getSenderName()
public
getSenderName() : mixed
getSubject()
public
getSubject() : mixed
getType()
public
getType() : mixed
getTypeDescription()
public
getTypeDescription() : mixed
isRemovable()
public
isRemovable() : mixed
isValidBody()
public
isValidBody(mixed $format) : mixed
Parameters
- $format : mixed
load()
Load e-mail template
public
load(string $type[, int $langId = 0 ]) : unknown
Get attributes of an e-mail template from the database and put them into the analogous class variables.
Parameters
- $type : string
- $langId : int = 0
Return values
unknownloadMails()
public
loadMails([mixed $type = null ][, mixed $langId = null ]) : mixed
Parameters
- $type : mixed = null
- $langId : mixed = null
next()
Load next mail
public
next() : mixed
nextLanguage()
public
nextLanguage() : mixed
setBodyHtml()
public
setBodyHtml(mixed $bodyHtml) : mixed
Parameters
- $bodyHtml : mixed
setBodyText()
public
setBodyText(mixed $bodyText) : mixed
Parameters
- $bodyText : mixed
setFormat()
public
setFormat(mixed $format) : mixed
Parameters
- $format : mixed
setLangId()
public
setLangId(mixed $langId) : mixed
Parameters
- $langId : mixed
setSenderMail()
public
setSenderMail(mixed $senderMail) : mixed
Parameters
- $senderMail : mixed
setSenderName()
public
setSenderName(mixed $senderName) : mixed
Parameters
- $senderName : mixed
setSubject()
public
setSubject(mixed $subject) : mixed
Parameters
- $subject : mixed
setType()
public
setType(mixed $type) : mixed
Parameters
- $type : mixed
store()
public
store() : mixed
validateBody()
public
validateBody() : mixed
validateFormat()
public
validateFormat() : mixed
validateSenderMail()
public
validateSenderMail() : mixed
validateSenderName()
public
validateSenderName() : mixed
validateType()
public
validateType() : mixed