related_item_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 RelatedItemSelectFieldRenderer extends FieldRenderer
{
     var $items;                   
     var $default;                 
     var $field;                        
     var $nameField;                    
     var $valueField;              
     var $allowAdd;                
     var $relatedClass;            
     var $constraint;              
     var $max_chars;                    
     var $allowNone;                    
     var $templateItem;            
     var $onItemAdded;             
     var $sorted;                  
     var $otherField;              
     var $onChange;                
     var $width;                        
     var $defaultText = "";        
     var $defaultReadOnlyText;     
     var $toggleAddNew;            
     var $addNewButtonText = "Add New"; 
     var $addNewCancelButtonText = "Cancel"; 
     var $onPostProcess;           
     
     static $optionsCache = array();
     
     function RelatedItemSelectFieldRenderer(&$form, $field, $label, $relatedClass, $constraint, $nameField, $valueField = "", $allowAdd = false, $allowNone = false, $maxChars = 80)
     {    
          $this->relatedClass = $relatedClass;
          $this->constraint = $constraint;
          $this->field = $field;
          $this->nameField = $nameField;
          $this->valueField = $valueField;
          $this->allowAdd = $allowAdd;
          $this->allowNone = $allowNone;
          $this->max_chars = $maxChars;
          $this->templateItem = null;
          $this->sorted = false;
          $this->toggleAddNew = false;
          
          $this->FieldRenderer($form);
          if ($form->data->hasField($field))
          {
               $form->override($field, $label, $this);
          }
          else
          {
               $form->add($this, $field);
               // JDG 8/14/2011 - allow "additional" fields to override label
               $form->overrides[$field]['label'] = $label;
          }
     }
     
     function allowOther($field)
     {
          $this->allowAdd = false; // Cannot have 'add' and 'other' at the same time
          $this->otherField = $field;
     }
     
     function showAddNewToggle($addNew = "Add New", $cancel = "Cancel")
     {
          $this->toggleAddNew = true;
          $this->addNewButtonText = $addNew;
          $this->addNewCancelButtonText = $cancel;
     }
     
     function renderScript($field)
     {
          $id = "{$this->parent->id}_{$field}";
?>
<script type='text/javascript'>
function <?php echo $id?>_onChange(elt)
{
     var addNewButton = document.id('<?echo $id?>_addnew_button');
     if (addNewButton)
     {
          if (elt.value == '')
          {
               addNewButton.setStyle('display', 'inline-block');
          }
          else
          {
               addNewButton.setStyle('display', 'none');
          }
     }
<?
          if ($this->onChange)
          {
?>
     return <?php echo $this->onChange?>(elt);
<?php 
          }
?>
}
<?php 
          if ($this->toggleAddNew)
          {
?>
function <?php echo $id?>_showAddNew()
{
     var addNew = document.id('<?php echo $id?>_addnew');
     var select = document.id('<?php echo $id?>_select');
     var text = document.id('<?php echo $id?>_addnew_text');
     addNew.setStyle('display', 'inline-block');
     select.setStyle('display', 'none');
     text.focus();
}
 
function <?php echo $id?>_hideAddNew()
{
     var addNew = document.id('<?php echo $id?>_addnew');
     var select = document.id('<?php echo $id?>_select');
     var elt = document.id('<?php echo $id?>');
     addNew.setStyle('display', 'none');
     select.setStyle('display', 'inline-block');
     elt.focus();
}
<?php 
          }
?>
</script>
<?php 
     }
     
     function renderField($field)
     {
          $this->getRelatedItems();
 
          if($this->width)
                    $style = "style='width: {$this->width}'";
          $this->_startField($field);
          
          $id = "{$this->parent->id}_{$field}";
          
          if ($this->allowAdd)
          {
               echo "<span id='{$id}_select'>";
          }
          echo "<select $style id='{$id}' name='$field'";
          
          echo " onchange='{$id}_onChange(this);'";
 
          echo ">\n";
 
          $vals = array();
          foreach($this->items as $item)
          {
               $name = $this->formatName($item, $this->nameField);
               $valueField = ($this->valueField != "") ? $this->valueField : $item->getPrimaryKey();
               $value = $item->get($valueField);
               if (!$value) $name = $this->defaultText;
               
               $vals[$name] = $value;
          }
          
          if ($this->sorted)
          {
               ksort($vals, SORT_LOCALE_STRING);
          }
          
          $current = $this->parent->data->get($field);
          
          foreach($vals as $name => $value)
          {
 
               $name = htmlSafe($name);
               $trunced = $this->max_chars ? ellipsis($name, $this->max_chars, true) : $name;
               //trace("valueField: $valueField", 3);
               
               echo "<option value='{$value}'";
               
               if ($trunced != $name) echo " title='$name'";
               
               /*
                * If this form is new and there is a default, then
                * set the default as selected. If this form is
                * retrieved or loaded from a saved record, then
                * set selected to the field value of that record
                */            
               if (($current != NULL) AND ($value == $current)) 
                    echo " selected";
               elseif (($current == NULL) AND ($value != NULL) AND ($value == $default))
                    echo " selected";
               echo ">$trunced</option>\n";            
          }
          echo "</select>";
          
          if ($this->allowAdd)
          {
               if ($this->toggleAddNew)
               {
                    echo " <a id='{$this->parent->id}_{$field}_addnew_button' href='#' class='button' onclick='{$id}_showAddNew(); return false'>{$this->addNewButtonText}</a></span>";
                    echo "<span id='{$this->parent->id}_{$field}_addnew' style='display: none; white-space: nowrap'><input type='text' id='{$id}_addnew_text' name='autoform_add_$field' value='' size='30'>";
                    echo " <a id='{$this->parent->id}_{$field}_cancel_button' href='#' class='button' onclick='{$id}_hideAddNew(); return false'>{$this->addNewCancelButtonText}</a></span>";
               }
               else
               {
                    echo "</span>";
                    echo "<span id={$this->parent->id}_{$field}_addnew' style='white-space: nowrap'> or add new: <input type='text' name='autoform_add_$field' value='' size='30'></span>";
               }
          }
          else if ($this->otherField)
          {
               $otherField = $this->otherField;
               $filter = $this->parent->data->getFilter();
               
               $value = $this->parent->data->get($otherField);
               
               $pkField = $this->parent->data->getPrimaryKey();
               if ($this->parent->data->get($pkField) && 
                    $filter && 
                    $filter->isExcluded($this->otherField))
               {
                    $obj = clone($this->parent->data);
                    $obj->setFilter(new InclusionFilter($obj->getPrimaryKey(), $this->otherField));
                    $obj->select();
                    $value = $obj->get($otherField);
               }
               else
               {
                    $value = $this->parent->data->get($otherField);
               }
               
               echo "<span style='white-space: nowrap'> if other, please specify: <input type='text' name='{$otherField}' value='{$value}' size='30'/></span>";
          }
          $this->_endField($field);
     }
     
     function renderSearchField($field, $mode)
     {
          if ($mode != "equal") return;
          
          $this->getRelatedItems();
          
          $this->_startField($field);
          
          if($this->width)
               $style = "style='width: {$this->width}'";
          
          echo "<select name='{$field}:$mode' $style>\n";
          
          //AJG: Don't add double empty slots when allowNone is true
          if (!$this->allowNone) 
          {
               echo "<option value=''></option>\n";
          }
          
          $value = $this->parent->params->get($field, $mode);
          
          foreach($this->items as $item)
          {
               $valueField = ($this->valueField != "") ? $this->valueField : $item->getPrimaryKey();
               $name = $this->formatName($item, $this->nameField);
 
               echo "<option value='{$item->get($valueField)}'";
               if ($item->get($valueField) == $value) echo " selected";
               echo ">".ellipsis($name, $this->max_chars)."</option>\n";             
          }
          echo "</select>";
          
          $this->_endField($field);
     }
     
     function renderReadOnly($field)
     {    
          $item = $this->getSelectedItem($field);
          
          $this->_startField($field);
          
          trace("RelatedItemSelectFieldRenderer renderReadOnly name field is {$this->nameField} field is $field and item is {$item->role}", 3);
          if (!$item->getPrimaryKeyValue())
          {
               trace("Using default readonly text '{$this->defaultReadOnlyText}'", 3);
               $name = $this->defaultReadOnlyText;
          }
          else
          {
               $name = $this->formatName($item, $this->nameField);
          }
          
          if (!$this->parent->readOnlyForm)
          {
               $valueField = ($this->valueField != "") ? $this->valueField : $item->getPrimaryKey();
               $value = $item->get($valueField);
               echo "<input type='hidden' id='{$this->parent->id}_{$field}' name='$field' value='$value'/>";
          }
          
          echo $name;
          
          $this->_endField($field);
          
     }
 
     function getRelatedItems($readonly = false)
     {
          $cacheKey = "$this->relatedClass, $this->constraint";
          
          if (array_key_exists($cacheKey, RelatedItemSelectFieldRenderer::$optionsCache))
          {
               $this->items = RelatedItemSelectFieldRenderer::$optionsCache[$cacheKey];
          }
          else
          {
               $this->items = query($this->relatedClass, $this->constraint);
               RelatedItemSelectFieldRenderer::$optionsCache[$cacheKey] = $this->items;
          }
          
          if ($this->allowNone)
          {
               $none = new $this->relatedClass;
               if (is_string($this->allowNone))
               {
                    $nameField = $this->nameField;
                    if ($readonly)
                    {
                         $none->set($nameField, $this->defaultReadOnlyText);
                    }
                    else if ($this->defaultText)
                    {
                         $none->set($nameField, $this->defaultText);
                    }
                    else
                    {
                         $none->set($nameField, $this->allowNone);
                    }
               }
               $this->items = array_merge(array($none), $this->items);
          }
          return $this->items;
     }
 
     function getSelectedItem($field)
     {
          $item = new $this->relatedClass;
          $valueField = $this->valueField ? $this->valueField : $item->getPrimaryKey();
          $value = $this->parent->data->get($field);
          
          try
          {
               $item = Query::create($this->relatedClass, "WHERE {$valueField}=:v")
                               ->bind(":v", $value)
                               ->executeSingle();
          }
          catch(DataNotFoundException $e)
          {
               $item = new $this->relatedClass;
          }
          
          return $item;
     }
     
     function preProcess($field = "")
     {
          trace("RelatedItemSelectFieldRenderer::process()", 3);
          
          $item = new $this->relatedClass;
          
          if ($this->otherField)
          {
               $filter = $this->parent->data->getFilter();
               
               // Ensure that the 'other' field value gets written
               if ($filter)
               {
                    $filter->includeField($this->otherField);
                    $otherField = $this->otherField;
                    $this->parent->data->set($otherField, isset($_POST[$otherField]) ? $_POST[$otherField] : "");
               }
          }
          
          if (!$this->allowAdd) return;
          $valueField = $valueField ? $this->valueField : $item->getPrimaryKey();
          $field = "autoform_add_{$this->field}";
          $val = $_POST[$field];
          
          trace("Checking for value '$val' in field $field", 3);
          
          if ($val)
          {
               foreach($this->items as $item)
               {
                    if ($val == $this->formatName($item, $this->nameField))
                    {
                         $this->data->set($valueField, $item->get($valueField));
                         return;
                    }
               }
               
               $obj = ($this->templateItem) ? $this->templateItem : new $this->relatedClass;
               $pk = $obj->getPrimaryKey();
               
               $nameField = $this->nameField;
               
               $obj->set($nameField, $val);
               $obj->save();
               
               if ($this->onItemAdded)
               {
                    call_user_func($this->onItemAdded, $this->parent, $obj);
               }
               
               $this->parent->data->set($this->field, $obj->get($pk));
          }
     }
     
     
     function postProcess($field = "")
     {
          if (is_callable($this->onPostProcess))
          {
               trace("*** Calling RelatedItemSelectFieldRenderer::\$onPostProcess", 3);
               call_user_func($this->onPostProcess, $this->parent);
          }
     }
}
?>