Source for file arraychoicelist.php

Documentation is available at arraychoicelist.php

  1. <?php
  2. /**
  3. * a choice list like DBChoiceList *not* based on an SQL statement
  4. *
  5. * @author    Stuart Prescott
  6. * @copyright  Copyright Stuart Prescott
  7. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  8. * @version    $Id$
  9. * @package    Bumblebee
  10. * @subpackage FormsLibrary
  11. */
  12.  
  13. /** Load ancillary functions */
  14. require_once 'inc/typeinfo.php';
  15. checkValidInclude();
  16.  
  17. /**
  18. * Provide a non-database filled (i.e. array-filled) version of DBChoiceList
  19. *
  20. * See DBChoiceList for more details of interface.
  21. * @see DBChoiceList
  22. * @package    Bumblebee
  23. * @subpackage FormsLibrary
  24. */
  25. class ArrayChoiceList {
  26.   /** @var string  id value currently selected  */
  27.   var $id=-1;
  28.   /** @var boolean  list is editable  */
  29.   var $editable = 0;
  30.   /** @var boolean  list is extensible by user */
  31.   var $extendable = 0;
  32.   /** @var boolean  list has changed */
  33.   var $changed = 0;
  34.   /** @var array    list of array($listKey => $unique_name, $displayKey => $displayed_value) */
  35.   var $choicelist;
  36.   /** @var integer  number of items in the list */
  37.   var $length;
  38.   /** @var string   array index in which to store the unique_name */
  39.   var $listKey;
  40.   /** @var string   array index in which to store the displayed_value */
  41.   var $displayKey;
  42.   /** @var integer  status code for out-of-band error reporting  */
  43.   var $oob_status = STATUS_NOOP;
  44.   /** @var string   error message for out-of-band error reporting  */
  45.   var $oob_errorMessage = '';
  46.  
  47.   /** @var integer  debug level for object  0=off.  */
  48.   var $DEBUG = 0;
  49.   
  50.   /**
  51.   *  Create a new ArrayChoiceList object
  52.   *
  53.   * @param array $array  list of unique_name => displayed_value
  54.   * @param string $iv    index in which the unique_name should be stored in the ChoiceList
  55.   * @param string $dv    index in which the displayed_value should be stored in the ChoiceList
  56.   */
  57.   function ArrayChoiceList($array, $iv, $dv) {
  58.     $this->choicelist = array();
  59.     $this->listKey = $iv;
  60.     $this->displayKey = $dv;
  61.     $item=0;
  62.     foreach ($array as $internalVal => $displayVal) {
  63.       $this->choicelist[$item] = array();
  64.       $this->choicelist[$item][$this->listKey] = $internalVal;
  65.       $this->choicelist[$item][$this->displayKey] = $displayVal;
  66.       $this->choicelist[$item]['_field'] = 0;
  67.       $item++;
  68.     }
  69.   }
  70.   
  71.   /**
  72.    * Construct an array suitable for storing the field and the values it takes for later reuse
  73.    * @param array $values list of values to be displayed
  74.    * @param Field $field  Field object associated with these values
  75.    */
  76.   function _mkaddedarray($values, $field='') {
  77.     $a = array();
  78.     $a[$this->listKey] = $values[0];
  79.     $a[$this->displayKey] = $values[1];
  80.     $a['_field'] = $field;
  81.     return $a;
  82.   }
  83.  
  84.   /**
  85.   * append a special field (such as "Create new:") to the choicelist
  86.   *
  87.   * This method is much simpler than the DB equivalent as we won't need to remember them.
  88.   *
  89.   * @see DBChoiceList::append()
  90.   * @param array $values list of values to be displayed
  91.   * @param Field $field (optional) a field class object to be placed next to this entry, if possible
  92.   */
  93.   function append($values, $field='') {
  94.     $fa = $this->_mkaddedarray($values, $field);
  95.     array_push($this->choicelist, $fa);
  96.   }
  97.  
  98.   /**
  99.   * prepend a special field (such as "Create new:") to the choicelist
  100.   *
  101.   * This method is much simpler than the DB equivalent as we won't need to remember them.
  102.   *
  103.   * @param array $values list of values to be displayed
  104.   * @param Field $field (optional) a field class object to be placed next to this entry, if possible
  105.   */
  106.   function prepend($values, $field='') {
  107.     $fa = $this->_mkaddedarray($values, $field);
  108.     array_unshift($this->choicelist, $fa);
  109.   }
  110.  
  111.   /**
  112.   * display the contents of the list
  113.   * @return string text representation of the field
  114.   */
  115.   function display() {
  116.     return $this->text_dump();
  117.   }
  118.  
  119.   /**
  120.   * display the contents of the list
  121.   * @return string text representation of the field
  122.   */
  123.   function text_dump() {
  124.     return "<pre>ArrayChoiceList:\n".print_r($this->choicelist, true).'</pre>';
  125.   }
  126.  
  127.   /** 
  128.   * update the value of the list based on user data:
  129.   *   - if it is within the range of current values, then take the value
  130.   *   - if the field contains a new value (and is allowed to) then keep
  131.   *     an illegal value, mark as being changed, and wait until later for
  132.   *     the field to be updated
  133.   *   - if the field contains a new value (and is not allowed to) or an
  134.   *     out-of-range value, then flag as being invalid
  135.   * 
  136.   * @param string $newval the (possibly) new value for the field
  137.   * @param array ancillary user data (passed on to any appended or prepended fields)
  138.   */
  139.   function update($newval, $data) {
  140.     if ($this->DEBUG) {
  141.       echo 'ArrayChoiceList update: ';
  142.       echo "(changed=$this->changed)";
  143.       echo "(id=$this->id)";
  144.       echo "(newval=$newval)";
  145.     }
  146.     if (isset($newval)) {
  147.       //check to see if the newval is legal (does it exist on our choice list?)
  148.       $isExisting = 0;
  149.       foreach ($this->choicelist as $v) {
  150.         if ($this->DEBUG) echo "($isExisting:".$v['id'].":$newval)";
  151.         if ($v['id'] == $newval && $v['id'] >= 0) {
  152.           $isExisting = 1;
  153.           break;
  154.         }
  155.       }
  156.       if ($isExisting) {
  157.         // it is a legal, existing value, so we adopt it 
  158.         if ($this->DEBUG) echo 'isExisting';
  159.         $this->changed += ($newval != $this->id);
  160.         $this->id = $newval;
  161.         $this->isValid = 1;
  162.         //isValid handling done by the Field that inherits it
  163.       } elseif ($this->extendable) {
  164.         // then it is a new value and we should accept it
  165.         if ($this->DEBUG) echo 'isExtending';
  166.         $this->changed += 1;
  167.         //$this->id = $newval;
  168.         //If we are extending the list, then we should have a negative
  169.         //number as the current value to trip the creation of the new
  170.         //entry later on in sync()
  171.         $this->id = -1;
  172.         foreach ($this->choicelist as $k => $v) {
  173.           //preDump($v);
  174.           if (isset($v['_field']) && $v['_field'] != "") {
  175.             $this->choicelist[$k]['_field']->update($data);
  176.             $this->isValid += $this->choicelist[$k]['_field']->isValid();
  177.           }
  178.         }
  179.       } else {
  180.         if ($this->DEBUG) echo 'isInvalid';
  181.         // else, it's a new value and we should not accept it
  182.         $this->isValid = 0;
  183.       }
  184.     }
  185.     #echo " DBchoiceList::changed=$this->changed<br />";
  186.     return $this->isValid;
  187.   }
  188.  
  189.   /**
  190.   * set the currently selected value
  191.   *
  192.   * @param string $value new value to use as curretly selected
  193.   */
  194.   function set($value) {
  195.     #echo "DBchoiceList::set = $value<br/>";
  196.     $this->id = $value;
  197.   }
  198.  
  199.   /**
  200.   * synchronise: but we have nothing to do as we are not attached to the db
  201.   * (provided to give interface to normal Field database)
  202.   * @return boolean false -- there was nothing to do
  203.   */
  204.   function sync() {
  205.     return false;
  206.   }
  207.  
  208.   /**
  209.   * generate name=value pairs in case someone actually wants them!
  210.   * 
  211.   * @return string of form name='value'
  212.   */
  213.   function _sqlvals() {
  214.     $vals = array();
  215.     if ($this->changed) {
  216.       #echo "This has changed";
  217.       foreach ($this->choicelist as $v) {
  218.         if (isset($v['_field'])) {
  219.           $vals[] = $v['_field']->name ."=". qw($v['_field']->value);
  220.         }
  221.       }
  222.     }
  223.     #echo "<pre>"; print_r($this->choicelist); echo "</pre>";
  224.     #echo "<pre>"; print_r($this->fields); echo "</pre>";
  225.     #echo "<pre>"; print_r($vals); echo "</pre>";
  226.     return join(",",$vals);
  227.   }
  228.  
  229.   /**
  230.   * determine whih values are selected and return them
  231.   * @param boolean $returnArray  return an array of values
  232.   * @return mixed list of selected values (array) or current value (string)
  233.   */
  234.   function selectedValue() {
  235.     $val = array();
  236.     foreach ($this->choicelist as $v) {
  237.       //echo "H:$this->idfield, $k, $v, $this->id";
  238.       if ($v[$this->listKey] == $this->id) {
  239.         foreach ($this->fields as $f) {
  240.           //echo "G=$f";
  241.           $val[] = $v[$f];
  242.         }
  243.       }
  244.     }
  245.     return implode(' ', $val);
  246.   }
  247.  
  248.   /**
  249.   * set which option in the selection list is the default option
  250.   * @param string $val   default value to use
  251.   */
  252.   function setDefault($val) {
  253.     //echo "ArrayChoiceList::setDefault: $val";
  254.     if (isset($this->id) || $this->id < 0) {
  255.       $this->id = $val;
  256.     }
  257.     //echo $this->id;
  258.   }
  259.  
  260. } // class ArrayChoiceList
  261.  
  262. ?>

Documentation generated on Tue, 06 Mar 2007 10:00:33 +0000 by phpDocumentor 1.3.0