EmailTemplateElement Class Reference

Inheritance diagram for EmailTemplateElement:
ModelElement Element ElementActionTypeInterface EmailMessageEmailTemplateElement

Public Member Functions

 __construct ($model, $attribute, $form=null, array $params=array())

Data Fields

const DISABLE_DROPDOWN_WHEN_AJAX_IN_PROGRESS = true
const DISABLE_TEXTBOX_WHEN_AJAX_IN_PROGRESS = true
const NOTIFICATION_BAR_ID = 'FlashMessageBar'
 $editableTemplate = '<th>{label}</th><td colspan="{colspan}"><div class="has-model-select">{content}</div>{error}</td>'

Protected Member Functions

 renderControlEditable ()
 wrapHasModelSelectInput (&$content)
 getName ()
 getId ()
 registerScripts ()
 registerChangeHandlerScript ()
 registerUpdateFlashBarScript ()
 renderLabel ()
 renderError ()
 getEditableHtmlOptions ()
 getEmailTemplateDetailsJsonUrl ()
 getTextContentId ()
 getSubjectId ()
 getHtmlContentId ()
 getCloneExitingFilesUrl ()
 getContactId ()
 getAutoCompleteUrlParams ()
 getSelectLinkUrlParams ()
 getNameForHiddenField ()
 getNameForTextField ()

Protected Attributes

 $name
 $id

Static Protected Attributes

static $moduleId = 'emailTemplates'

Detailed Description

Display the emailTemplate selection. This is a combination of a type-ahead input text field and a selection button which renders a modal list view to search on emailTemplates. Also includes a hidden input for the user id.

Definition at line 44 of file EmailTemplateElement.php.


Constructor & Destructor Documentation

__construct ( model,
attribute,
form = null,
array $  params = array() 
)

Constructs the element specifying the model and attribute. In the case of needing to show editable information, a form is also provided.

Parameters:
$form Optional. If supplied an editable element will be rendered.
$params Can have additional parameters for use. 'wide' true or false is an example parameter

Reimplemented from Element.

Definition at line 60 of file EmailTemplateElement.php.


Member Function Documentation

renderControlEditable (  )  [protected]

Render a hidden input, a text input with an auto-complete event, and a select button. These three items together form the Account Editable Element

Returns:
The element's content as a string.

Reimplemented from ModelElement.

Reimplemented in EmailMessageEmailTemplateElement.

Definition at line 82 of file EmailTemplateElement.php.

getName (  )  [protected]
Returns:
stringified name if it exists or empty string to avoid (unnamed) being shown.

Reimplemented from ModelElement.

Definition at line 92 of file EmailTemplateElement.php.

getId (  )  [protected]
Returns:
id if a real model, otherwise an empty string to ensure the
See also:
ZurmoHtml::activeInputField works properly when resolving the id.

Reimplemented from ModelElement.

Definition at line 97 of file EmailTemplateElement.php.

renderLabel (  )  [protected]

Override to support the module labels for the models.

Reimplemented from ModelElement.

Definition at line 300 of file EmailTemplateElement.php.

renderError (  )  [protected]

Generate the error content. Used by editable content

Returns:
error content

Reimplemented from Element.

Definition at line 313 of file EmailTemplateElement.php.


Field Documentation

$moduleId = 'emailTemplates' [static, protected]

Override in child element with a specific moduleId

Reimplemented from ModelElement.

Definition at line 54 of file EmailTemplateElement.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Tue Jul 16 07:11:01 2019