EmailListFieldRenderer Class Reference

Inherits TextFieldRenderer.

Public Member Functions
	EmailListFieldRenderer (&$form, $field, $label="")
	addValidatorsToForm ($field, $required=false)
	renderField ($field)
	preProcess ($field="")

Static Public Member Functions
static	cleanup ($recipients)
	Given a string of emails, clean up the list, removing any ";" or extra spaces, or trailing punctuation. More...

Public Attributes
	$removeDuplicates = false

Detailed Description

Definition at line 47 of file email_recipients_field_renderer.inc.

Member Function Documentation

addValidatorsToForm()

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

Definition at line 68 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));
          }
     }

cleanup()

static EmailListFieldRenderer::cleanup (   $recipients )

static

Given a string of emails, clean up the list, removing any ";" or extra spaces, or trailing punctuation.

Parameters

String

$recipients

Definition at line 110 of file email_recipients_field_renderer.inc.

     {
          $patterns = array("/,\s+/", "/;\s+/");
          $replacements = array(",", ",");
          $recipients = preg_replace($patterns, $replacements, $recipients);
          $recipients = rtrim($recipients, ",;");
          
          return $recipients;
     }

EmailListFieldRenderer()

EmailListFieldRenderer::EmailListFieldRenderer	(	&	$form,
			$field,
			$label = ""
	)

Definition at line 51 of file email_recipients_field_renderer.inc.

     {
          parent::TextFieldRenderer($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;
          }         
     }

preProcess()

EmailListFieldRenderer::preProcess

(

$field = ""

)

Definition at line 90 of file email_recipients_field_renderer.inc.

     {
          if(!$field) $field = "recipients";
          
          $recipients = EmailListFieldRenderer::cleanup($this->parent->data->get($field));
          
          if($this->removeDuplicates)
          {
               $recipients = implode(",", array_unique(explode(",", $recipients)));
          }
          
          $this->parent->data->set($field, $recipients);
     }

renderField()

EmailListFieldRenderer::renderField

(

$field

)

Definition at line 81 of file email_recipients_field_renderer.inc.

     {
          $recipients = $this->parent->data->get($field);
          $recipients = preg_replace("/,\s*/", ", ", $recipients);
          $this->parent->data->set($field, $recipients);
          
          parent::renderField($field);
     }

Member Data Documentation

$removeDuplicates

EmailListFieldRenderer::$removeDuplicates = false

Definition at line 49 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