Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Asset_Attribute_Email_Format Class Reference
Inheritance diagram for Asset_Attribute_Email_Format:
Asset_Attribute_WYSIWYG Asset_Attribute_Text Asset_Attribute MySource_Object

Public Member Functions

 Asset_Attribute_Email_Format ($attributeid=0, $value=NULL)
 
 setEditParams (&$node)
 
 paint ($prefix, $read_only=FALSE)
 
 process ($prefix)
 
 validateValue (&$value)
 
 sendMail ($replacements=Array(), $additional_attachments=Array())
 
 getKeywords ()
 
- Public Member Functions inherited from Asset_Attribute_WYSIWYG
 Asset_Attribute_WYSIWYG ($attributeid=0, $value=null)
 
 setEditParams (&$node)
 
_createEditor ($prefix)
 
 paint ($prefix, $read_only=false)
 
 process ($prefix, $owner_id=NULL, $cmp_value=TRUE)
 
 getKeywordValue ($format='')
 
 setValue (&$value, $owner_id=NULL)
 
 paintBackendStatusIcons ($wysiwyg)
 
- Public Member Functions inherited from Asset_Attribute_Text
 Asset_Attribute_Text ($attributeid=0, $value=null)
 
 paintEditParams ($prefix, $write_access=false)
 
 processEditParams ($prefix)
 
 setEditParams (&$node)
 
 paint ($prefix, $read_only=false)
 
 process ($prefix)
 
 validateValue (&$value)
 
- Public Member Functions inherited from Asset_Attribute
 Asset_Attribute ($attributeid=0, $value=NULL, $default_params=Array())
 
loadAttribute ($attributeid=0, $value=NULL, $default_params=Array())
 
 type ()
 
 paint ($prefix, $read_only=FALSE)
 
 paintEditParams ($prefix, $write_access=FALSE)
 
 processEditParams ($prefix)
 
 process ($prefix)
 
 validateValue (&$value)
 
 setValue (&$value)
 
 setEditParams (&$node)
 
 setEditParam ($field, $value)
 
 setParam ($field, $value)
 
 getContent ()
 
 getKeywordValue ($format='')
 
 exportToXML ()
 
 exportContentsToXML ()
 
- Public Member Functions inherited from MySource_Object
 MySource_Object ()
 
 __sleep ()
 
 __wakeup ()
 

Additional Inherited Members

- Data Fields inherited from Asset_Attribute
 $id = 0
 
 $name = ''
 
 $uniq = FALSE
 
 $description = ''
 
 $_params = Array()
 
 $_default_value = NULL
 
 $_edit_params = Array()
 
 $value = NULL
 
 $processed = FALSE
 
 $is_admin = FALSE
 

Detailed Description

Definition at line 35 of file email_format.inc.

Member Function Documentation

Asset_Attribute_Email_Format (   $attributeid = 0,
  $value = NULL 
)

Constructor

Parameters
int$attributeidthe attribute id to be loaded
mixed$valuethe current value for the element

Definition at line 46 of file email_format.inc.

getKeywords ( )

Get any keywords that are present in this attr's components

Returns
void public

Definition at line 631 of file email_format.inc.

paint (   $prefix,
  $read_only = FALSE 
)

Print the interface for filling in a value

Parameters
string$prefixprefix for the form elements
boolean$read_onlyare we just printing the value
Returns
void public

Definition at line 92 of file email_format.inc.

process (   $prefix)

Process the interface for filling in a value

Parameters
string$prefixprefix for the form elements
Returns
void public

Definition at line 315 of file email_format.inc.

sendMail (   $replacements = Array(),
  $additional_attachments = Array() 
)

Use the values stored in this attribute to send an email

Parameters
array$replacementsan array of keyword replacements
array$additional_attachmentsadditional filepaths to attach to the email (must be inside data directory)
Returns
void public

Definition at line 443 of file email_format.inc.

setEditParams ( $node)

Takes an XML_Tree_Node from an edit interface XML file and creates the params array from it

Parameters
object&$nodeXML_Tree_Node object.
Returns
boolean public

Definition at line 68 of file email_format.inc.

validateValue ( $value)

Ensure the attribute being set is an array

Parameters
mixed&$valuevalue to be validated
Returns
boolean public

Definition at line 375 of file email_format.inc.


The documentation for this class was generated from the following file: