FilterFieldRenderer Class Reference

Inherits SelectFieldRenderer.

Classes
class	BooleanFilterFieldRenderer
class	CheckListFilterFieldRenderer
	Usage: More...
class	DateRangeFilterRenderer
	Adds a Date Range Filter with start and end dates and Next and Previous buttons to a FilterForm. More...
class	RadioButtonFilterFieldRenderer

Public Member Functions
	FilterFieldRenderer (&$form, $field, $label="", $options=null)
	setDefault ($title, $value)
	renderField ($field)
	renderSearchField ($field)
	renderField ($field)

Static Public Member Functions
static	formatOptions ($items, $template)

Public Attributes
	$options
	$label
	$all = true
	$all_value = ""
	$width = ""
	$cssClass = 'select'

Detailed Description

Definition at line 429 of file filter_form.inc.

Member Function Documentation

FilterFieldRenderer()

FilterFieldRenderer::FilterFieldRenderer	(	&	$form,
			$field,
			$label = "",
			$options = null
	)

Definition at line 438 of file filter_form.inc.

     {
          $this->options = $options;
          $this->label = ($label) ? $label : prettify($field);
          $this->FieldRenderer($form);
          if ($form->getData()->hasField($field))
          {
               // JDG 5/30/11 - don't crash on additiona/psuedo fields
               // only query if real field
               $form->override($field, $label, $this);
               if ($this->options == null)
               {
                    $opt = $form->getData()->distinctValues($field, true);
                    if (count($opt) > 0)
                    {
                         $this->options = array_combine($opt, $opt);
                    }
                    else
                    {
                         $this->options = array();
                    }
               }
          }
          else
          {
               $form->add($this, $field);
               // JDG 7/22/2011 - allow "additional" fields to override label
               $form->overrides[$field]['label'] = $label;
          }
     }

formatOptions()

static FilterFieldRenderer::formatOptions (   $items,   $template  )

static

Definition at line 528 of file filter_form.inc.

     {
          $options = array();
 
          // user sent just the field name
          if(!preg_match("/^\{/", $template))
               $template = "{" . $template . "}";
               
          if(count($items) == 0)
               return $options;
               
          foreach($items as $item)
          {
               $pk = $item->getPrimaryKey();
               $options[$item->$pk] = $item->format("$template");
          }
          return $options;
     }

renderField() [1/2]

FilterFieldRenderer::renderField

(

$field

)

Definition at line 475 of file filter_form.inc.

     {
          $this->_startField($field, $this->styles);
          
          if($this->width)
          {
               $styles .= "style='width: {$this->width}'";
          }
               
          $onSubmit = $this->parent->getOnSubmitFunction();
          echo "<select name='{$field}' {$styles} onchange='if ({$onSubmit}(this.form)) this.form.manager.submit();'>";
     
     if ($this->default)
     {
   ?>
          <option value="<?php echo $this->defaultValue ?>"><?echo $this->default?></option>     
   <?
     }
     
     if($this->all)
     {
     ?>
          <option value="<?php echo $this->all_value ?>">All</option>  
          <?
     }
     
          $fieldValue = $this->parent->data->get("$field");
          foreach($this->options as $value => $name)
          {
               $name = htmlSafe($name);
               $trunced = $this->max_chars ? ellipsis($name, $this->max_chars, true) : $name;
          
               $selected = (!strcmp($value, $fieldValue)) ? " selected" : "";
               $optionTitle = ($name != $trunced) ? " title='$name'" : "";
               
               echo "<option value='{$value}' $selected>$trunced</option>\n";
          }
          
          echo "</select>&nbsp;";
          
          $this->_endField($field);
     }

renderField() [2/2]

FilterFieldRenderer::renderField

(

$field

)

Definition at line 1300 of file filter_form.inc.

     {
          $this->renderSearchField($field);
     }

renderSearchField()

FilterFieldRenderer::renderSearchField

(

$field

)

Definition at line 518 of file filter_form.inc.

     {
          $this->renderField($field);
     }

setDefault()

FilterFieldRenderer::setDefault	(		$title,
			$value
	)

Definition at line 469 of file filter_form.inc.

     {
          $this->default = $title;
          $this->defaultValue = $value;
     }

Member Data Documentation

$all

FilterFieldRenderer::$all = true

Definition at line 433 of file filter_form.inc.

$all_value

FilterFieldRenderer::$all_value = ""

Definition at line 434 of file filter_form.inc.

$cssClass

FilterFieldRenderer::$cssClass = 'select'

Definition at line 436 of file filter_form.inc.

$label

FilterFieldRenderer::$label

Definition at line 432 of file filter_form.inc.

$options

FilterFieldRenderer::$options

Definition at line 431 of file filter_form.inc.

$width

FilterFieldRenderer::$width = ""

Definition at line 435 of file filter_form.inc.

---

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

• C:/code/cms.sonjara.com/framework/filter_form.inc