Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PreparedEmailForm Class Reference
Inheritance diagram for PreparedEmailForm:
Form

Public Member Functions

 execute ()
 
getContext ()
 
 getEmailKey ()
 
 getLocaleFieldNames ()
 
 initData ($request)
 
 PreparedEmailForm ($emailKey=null, &$context)
 
 readInputData ()
 
 setEmailKey ($emailKey)
 
- Public Member Functions inherited from Form
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 display ($request=null, $template=null)
 
 execute ($object=null)
 
 fetch ($request, $template=null, $display=false)
 
 Form ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getFormLocale ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isLocaleResubmit ()
 
 isValid ()
 
 readInputData ()
 
 readUserDateVars ($vars)
 
 readUserVars ($vars)
 
 setData ($key, $value)
 
 setTemplate ($template)
 
 smartyFormLanguageChooser ($params, &$smarty)
 
 validate ($callHooks=true)
 

Public Attributes

 $_context
 
 $_emailKey
 
- Public Attributes inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form for creating and modifying prepared emails.

See Also
EmailTemplateDAO

Definition at line 20 of file PreparedEmailForm.inc.php.

Member Function Documentation

PreparedEmailForm::execute ( )
& PreparedEmailForm::getContext ( )

Get the context

Returns
Context

Definition at line 66 of file PreparedEmailForm.inc.php.

References $_context.

Referenced by execute(), initData(), and readInputData().

PreparedEmailForm::getEmailKey ( )

Get the email key

Returns
string

Definition at line 58 of file PreparedEmailForm.inc.php.

References $_emailKey.

Referenced by execute(), initData(), and readInputData().

PreparedEmailForm::getLocaleFieldNames ( )

Get all locale field names

Definition at line 119 of file PreparedEmailForm.inc.php.

PreparedEmailForm::initData (   $request)

Initialize form data from current settings.

Definition at line 73 of file PreparedEmailForm.inc.php.

References getContext(), DAORegistry\getDAO(), getEmailKey(), AppLocale\getLocale(), AppLocale\requireComponents(), and Form\setData().

PreparedEmailForm::PreparedEmailForm (   $emailKey = null,
$context 
)

Constructor.

Parameters
$emailKeystring
$contextContext

Definition at line 33 of file PreparedEmailForm.inc.php.

References Form\addCheck(), and setEmailKey().

PreparedEmailForm::readInputData ( )

Assign form data to user-submitted data.

Definition at line 105 of file PreparedEmailForm.inc.php.

References getContext(), DAORegistry\getDAO(), getEmailKey(), Form\readUserVars(), and Form\setData().

PreparedEmailForm::setEmailKey (   $emailKey)

Set the email key

Parameters
$emailKeystring

Definition at line 50 of file PreparedEmailForm.inc.php.

Referenced by PreparedEmailForm().

Member Data Documentation

PreparedEmailForm::$_context

The context of the email template being edited

Definition at line 26 of file PreparedEmailForm.inc.php.

Referenced by getContext().

PreparedEmailForm::$_emailKey

The key of the email template being edited

Definition at line 23 of file PreparedEmailForm.inc.php.

Referenced by getEmailKey().


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