select_field_renderer.inc

Go to the documentation of this file.

<?php
/**************************************************************
 
 Copyright (c) 2007-2010 Sonjara, Inc
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without
 restriction, including without limitation the rights to use,
 copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following
 conditions:
 
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
 
 Except as contained in this notice, the name(s) of the above 
 copyright holders shall not be used in advertising or otherwise 
 to promote the sale, use or other dealings in this Software 
 without prior written authorization.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 
*****************************************************************/
 
require_once realpath(dirname(__FILE__))."/../field_renderers.inc";
 
class SelectFieldRenderer extends FieldRenderer
{
     var $options;       
     var $addEntry;      
     var $addEntryText;  
     var $onChange;           
     var  $max_chars;         
     var $width;              
 
     var $defaultBlank = false;              
     var $defaultText = "Choose One";   
     var $defaultValue = "";                 
     var $allowDeselect = false;             
     
     var $CSSclass;      
     var $stripHTML = false; 
     
     function SelectFieldRenderer(&$form, $field, $label, $options = null, $onChange="", $grouped = false)
     {
          $this->options = $options;
          $this->onChange = $onChange;
          $this->grouped = $grouped;
          $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;
          }
          
     }
     
     function setMaxChars($max)
     {
          $this->max_chars = $max;
          return $this;
     }
     
     function allowAddEntry($text = "or add new")
     {
          $this->addEntry = true;
          $this->addEntryText = $text;
          $this->addOtherOption();
          return $this;
     }
     
     function allowBlank($text = "", $value = "")
     {
          if (!$this->grouped && !$text) $text = "Choose One";
          $this->defaultBlank = true;
          $this->defaultText = $text;
          $this->defaultValue = $value;
          return $this;
     }
     
     function addDefaultOption($field)
     {
          $val = $this->parent->data->get($field);
          if(!$this->defaultBlank || ($val && !$this->allowDeselect)) return;
          
          if(count($this->options) && !array_search("", $this->options))
          {
               // want the blank at the top - array_merge causes issues; copy array instead
               $options[$this->defaultValue] = $val ? "" : $this->defaultText;
               foreach($this->options as $key => $value)
               {
                    $options[$key] = $value;
               }
               $this->options = $options;
          }
     }
 
     function extendOptions($options)
     {
          if ($this->grouped)
          {
               throw new FakoliException("SelectFieldRenderer::extendOptions() not supported in grouped mode");
          }
          
          foreach($options as $value => $text)
          {
               if (!array_key_exists($value, $this->options))
               {
                    $this->options[$value] = $text;
               }
          }
     }
     
     function renderField($field)
     {
          $this->_startField($field);
               
          if (count($this->options) > 0 || !$this->addEntry)
          {              
               $cssClass = $this->CSSclass ? " class='{$this->CSSclass}'" : "";
               if($this->width)
                    $style = "style='width: {$this->width}'";
               echo "<select {$class}{$style} name='$field' id='{$this->parent->id}_{$field}'";
               
               if ($this->onChange != "")
                    echo " onchange='$this->onChange(this)'";
               elseif($this->addEntry)
                    echo " onchange='onChange_{$this->parent->id}_{$field}(this)'";
               
               echo ">\n";
               
               /* Check if we have addEntry text coming in from the db;
                * othEntry is text that doesn't match the set of options
                * for this field
                * */
               $othEntry = true;
               $current = $this->parent->data->get($field);
               
               if ($this->parent->data->getType($field) == 'String')
               {
                    $comparator = function($a, $b) { return (strcmp($a, $b) == 0);   };
               }
               else
               {
                    $comparator = function($a, $b) { return $a == $b; };
               }
               
               if ($this->grouped)
               {
                    if ($this->defaultBlank)
                    {
                         echo "<option value=''>{$this->defaultText}</option>\n";
                    }
                    
                    //$this->addDefaultOption($field); 
                    
                    foreach($this->options as $groupName => $group)
                    {
                         if ($groupName == "")
                         {
                              //echo "<option value=''>{$this->defaultText}</option>\n";
                              continue;
                         }
                         
                         echo "<optgroup label=\"$groupName\">\n";
                         
                         foreach($group as $value => $name)
                         {
                              $name = ($this->stripHTML) ? stripHTML($name) : htmlSafe($name);
                              $trunced = $this->max_chars ? ellipsis($name, $this->max_chars, true) : $name;
                              
                              if ($comparator($current, $value))
                              {
                                   $selected = " selected";
                                   $othEntry = false;
                              }
                              else
                                   $selected = "";
                              
                              trace("$current == $value ".($current==$value)." $selected", 3);
                              
                              $optionTitle = ($name != $trunced) ? " title='$name'" : "";
                              
                              echo "<option$optionTitle value='".htmlSafe($value)."'$selected>$trunced</option>\n";
                         }
                         
                         echo "</optgroup>\n";
                    }
               }
               else
               {    
                    /*
                     * If there is no match but there is a value saved, 
                     * (user entered an addEntry value) then set current 
                     *  to blank so that the "Other" option is shown as selected. 
                     */       
                    if(!array_key_exists($current, $this->options))
                    {
                         $addEntryValue = $current;
                         $current = "";
                    }
               
                    $this->addDefaultOption($field);   
          
                    foreach($this->options as $value => $name)
                    {
                         $name = ($this->stripHTML) ? stripHTML($name) : htmlSafe($name);
                         $trunced = $this->max_chars ? ellipsis($name, $this->max_chars, true) : $name;
                         
                         if($comparator($current, $value))
                         {
                              $selected = " selected";
                         }
                         else
                              $selected = "";
                              
                         $optionTitle = ($name != $trunced) ? " title='$name'" : "";
                         
                         echo "<option$optionTitle value='".htmlSafe($value)."'$selected>$trunced</option>\n";
                    }
               }
               
               echo "</select>\n";
          }
          
          /*
           * We need to create this field whether displayed or not so that the
           * custom required validator, SelectFieldRequiredValidator, works for 
           * either case.
           */
          $type = $this->addEntry ? 'text' : 'hidden';
          
          if ($this->addEntry)
          {
               echo "&nbsp;{$this->addEntryText}&nbsp;";
               $onChange = " onchange='onChange_{$this->parent->id}_{$field}_addEntry(this)'";
               
          }    
          echo "<input type='$type' name='{$field}_addEntry' class='add_entry' id='{$field}_addEntry' value='{$addEntryValue}' size='20' $onChange/>";
          
          $this->_endField($field);
     }
     
     function renderSearchField($field, $mode, $value = "")
     {
          if ($mode != "equal" && $mode != "member") $mode = "equal";
          
          $searchValue = (!$value) ? $this->parent->params->get($field, $mode) : $value;
          
          $this->_startField($field);
 
          if($this->width)
          {
               $style = "style='width: {$this->width}'";
          }
          
          echo "<select $style id='$field' name='$field:$mode'";
          
          if ($this->onChange != "")
               echo " onchange='$this->onChange(this)'";
          
          echo "><option value=''></option>\n";
          foreach($this->options as $value => $name)
          {
               $selected = ($searchValue === $value) ? " selected" : "";
               $name = ($this->stripHTML) ? stripHTML($name) : htmlSafe($name);
                    
               echo "<option value='".htmlSafe($value)."'$selected>$name</option>";
          }
          echo "</select>\n";
          
          $this->_endField($field);
     }
     
     
     function renderReadOnly($field)
     {
          $this->_startField($field);
 
          $value = $this->parent->data->get($field);
          if ($this->grouped)
          {
               $found = false;
               foreach($this->options as $group => $options)
               {
                    if (array_key_exists($value, $options))
                    {
                         echo $options[$value];
                         $found = true;
                         break;
                    }
               }
               if (!$found)
               {
                    echo "Not specified";
               }
          }
          else
          {
               if (array_key_exists($value, $this->options))
               {
                    echo $this->options[$value];
               }
               elseif($value)
               {
                    echo $value;
               }
               else
               {
                    echo "Not specified";
               }
          }
          
          $this->_endField($field);
     }
     
     function preProcess($field = "")
     {
          $found = false;
          
          $current = $this->parent->data->get($field);
 
          if ($this->grouped)
          {
               foreach($this->options as $groupName => $group)
               {
                    foreach($group as $value => $name)
                    {
                         if($current == $value && $value != '')
                              $found = true;
                    }
               }
          }
          else
          {
               foreach($this->options as $value => $name)
               {
                    if($current == $value && $value != '')
                         $found = true;
               }
          }
 
          $addEntry = $_POST["{$field}_addEntry"];
          trace("addEntry($field): $addEntry and found $found", 3);
          
          if ($_POST["{$field}_addEntry"] && !$found)
          {
               trace("setting field $field with add entry value $addEntry", 3);
               $this->parent->data->set($field,  $addEntry);
          }
     }
     
     function renderScript($field)
     {
          $fn = "{$this->parent->id}_$field";
          $addEntry = $field . "_addEntry";
          
          if(!$this->onChange && $this->addEntry)
          {
?>
<script type="text/javascript">
function onChange_<?echo $fn?>(elt)
{
     if(!elt.value == '')
     {
          var addEntry = document.id('<?php echo $addEntry ?>');
          if(addEntry)
               addEntry.value = '';          
     }
}
</script>
<?
          } // end if onChange and addEntry
 
          if($this->addEntry)
          {
?>
     <script type="text/javascript">
function onChange_<?echo "{$fn}_addEntry" ?>(elt)
{
     if(elt.value)
     {
          var selected = document.id('<?php echo $field ?>');
          if(selected)
               selected.value = '';          
     }
}
</script> 
<?php     
          } // ent if this addEntry          
     } // end function renderScript
     
     
     function addOtherOption($text = "Other")
     {
          if(!array_key_exists("", $this->options))
          {
               $this->options[""] = $text;
          }    
 
          return $this;
     }
 
     
} // end class SelectFieldRenderer
?>