EmailRecipientScrollBoxFieldRenderer Class Reference

Displays email recipients in mail client type of bubble inside a scrollbox. More...

Inherits FieldRenderer.

Public Member Functions
	EmailRecipientScrollBoxFieldRenderer (&$form, $field, $label="", $recipients, $nameField, $delete_fn="", $delete_all_fn)
	renderField ($field)
	addValidatorsToForm ($field, $required=false)
	renderReadOnly ($field)
	formatRecipients ($recipients)
	formatOneRecipient ($recipient)
	Construct a list member using the id and value, such as id: "user_id_7" value "Sam Jones". More...

Public Attributes
	$cssClass = 'email_recipient_scrollbox'
	$field
	$nameField
	$recipients
	$delete_fn
	js function to delete selected recipient using "x" More...
	$delete_all_fn
	js function to delete all recipients More...
	$deleteLabel = "Clear All"

Detailed Description

Displays email recipients in mail client type of bubble inside a scrollbox.

Author

janice

Definition at line 128 of file email_recipients_field_renderer.inc.

Member Function Documentation

addValidatorsToForm()

EmailRecipientScrollBoxFieldRenderer::addValidatorsToForm	(		$field,
			$required = false
	)

Definition at line 187 of file email_recipients_field_renderer.inc.

     {
          $label = isset($this->label) ? $this->label : $this->parent->prettifyFieldName($field);
     
          $this->parent->validator->add(new EmailListValidator($field, $label));
     
          if($required)
          {
               $this->parent->validator->add(new RequiredValidator($field, $label));
          }
     }

EmailRecipientScrollBoxFieldRenderer()

EmailRecipientScrollBoxFieldRenderer::EmailRecipientScrollBoxFieldRenderer	(	&	$form,
			$field,
			$label = "",
			$recipients,
			$nameField,
			$delete_fn = "",
			$delete_all_fn
	)

Definition at line 138 of file email_recipients_field_renderer.inc.

     {
          $this->recipients = $recipients;
          $this->field = $field;
          $this->nameField = $nameField;
          
          parent::FieldRenderer($form);
          
          $label = ($label) ? $label : prettify($field);
          
          if ($form->data->hasField($field))
          {
               $form->override($field, $label, $this);
          }
          else
          {
               $form->add($this, $field);
               $form->overrides[$field]['label'] = $label;
          }         
          
          $this->delete_fn = $delete_fn;     
          $this->delete_all_fn = $delete_all_fn;
          $this->colspan = 2;
     }

formatOneRecipient()

EmailRecipientScrollBoxFieldRenderer::formatOneRecipient

(

$recipient

)

Construct a list member using the id and value, such as id: "user_id_7" value "Sam Jones".

Parameters

String	$id
String	$value

Definition at line 228 of file email_recipients_field_renderer.inc.

     {
          $pk = $recipient->getPrimaryKey();
          $nameField = $this->nameField;
          if($this->delete_fn)
          {
               $removeLink = "<a class='remove_recipient' href='#' onclick='{$this->delete_fn}({{$pk}}); return false;'>x</a>";
          }
          
          return $recipient->format("<div id='{$pk}_{{$pk}}' class='email_recipient'>{$nameField}{$removeLink}</div>");
     }

formatRecipients()

EmailRecipientScrollBoxFieldRenderer::formatRecipients

(

$recipients

)

Definition at line 207 of file email_recipients_field_renderer.inc.

     {
          if(!count($recipients)) return "";
          
          foreach($recipients as $recipient)
          {
               $html .= $this->formatOneRecipient($recipient);
          }         
          
          return $html;
     }

renderField()

EmailRecipientScrollBoxFieldRenderer::renderField

(

$field

)

Definition at line 163 of file email_recipients_field_renderer.inc.

     {
          $this->_startField($field);
          
          $recipients = $this->recipients;
          
          echo "<div id='email_recipients'>\n";
               
          if($this->delete_all_fn)
          {
               $pk = $this->parent->data->getPrimaryKey();
               $id = $this->parent->data->$pk;
               echo "<a class='button' href='' onclick=\"{$this->delete_all_fn}($id); return false;\">{$this->deleteLabel}</a>\n";
          }
          echo "<div id='{$this->parent->id}_{$field}' class='{$this->cssClass}' name='$field'>\n";
          
          echo $this->formatRecipients($recipients);
          
          echo "</div>\n";
          echo "</div>\n";
          
          $this->_endField($field);
     }

renderReadOnly()

EmailRecipientScrollBoxFieldRenderer::renderReadOnly

(

$field

)

Definition at line 200 of file email_recipients_field_renderer.inc.

     {
          $this->delete_fn = "";
          $this->delete_all_fn = "";
          $this->renderField($field);
     }

Member Data Documentation

$cssClass

EmailRecipientScrollBoxFieldRenderer::$cssClass = 'email_recipient_scrollbox'

Definition at line 130 of file email_recipients_field_renderer.inc.

$delete_all_fn

EmailRecipientScrollBoxFieldRenderer::$delete_all_fn

js function to delete all recipients

Definition at line 135 of file email_recipients_field_renderer.inc.

$delete_fn

EmailRecipientScrollBoxFieldRenderer::$delete_fn

js function to delete selected recipient using "x"

Definition at line 134 of file email_recipients_field_renderer.inc.

$deleteLabel

EmailRecipientScrollBoxFieldRenderer::$deleteLabel = "Clear All"

Definition at line 136 of file email_recipients_field_renderer.inc.

$field

EmailRecipientScrollBoxFieldRenderer::$field

Definition at line 131 of file email_recipients_field_renderer.inc.

$nameField

EmailRecipientScrollBoxFieldRenderer::$nameField

Definition at line 132 of file email_recipients_field_renderer.inc.

$recipients

EmailRecipientScrollBoxFieldRenderer::$recipients

Definition at line 133 of file email_recipients_field_renderer.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/email/email_recipients_field_renderer.inc