Source for file datareflector.php

Documentation is available at datareflector.php

  1. <?php
  2. /**
  3. * reflect all submitted data back to the user
  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. * Reflects all inputted data through hidden fields
  19. *
  20. * Can optionally exclude some fields
  21. *
  22. * Typical usage:<code>
  23. *     $ref = new DataReflector();
  24. *     $ref->exclude(array('id', 'name'));
  25. *     $ref->excludeRegEx(array('/^setting-.+/'));
  26. *     echo $ref->display($_POST);
  27. * </code>
  28. * @package    Bumblebee
  29. * @subpackage FormsLibrary
  30. */
  31. class DataReflector {
  32.   /** @var string  basename that will be appended to all keys */
  33.   var $basename = '';
  34.   /** @var array   list of fields to exclude from the datareflector */
  35.   var $excludes = array();
  36.   /** @var array   list of regexp fields to exclude from the datareflector  */
  37.   var $excludesRegEx = array();
  38.   /** @var array   list of list of keys that have value restrictions */
  39.   var $limitKeys = array();
  40.   /** @var array   list of list of values that are acceptable for the limited keys */
  41.   var $limitValues = array();
  42.   /** @var integer   debug level    */
  43.   var $DEBUG = 0;
  44.  
  45.   /**
  46.   *  Create a datareflector object
  47.   */
  48.   function DataReflector() {
  49.   }
  50.  
  51.   /**
  52.   *  Creates hidden fields html representation
  53.   *
  54.   * @param array $PD  array of $field => $value
  55.   * @return string  html hidden fields
  56.   */
  57.   function display($PD) {
  58.     $t = '';
  59.     foreach ($PD as $key => $val) {
  60.       if ($this->_includeKey($key, $val)) {
  61.       // then we should be included in the reflection
  62.         $t .= sprintf('<input type="hidden" name="%s" value="%s" />',
  63.                         $this->basename.xssqw($key),
  64.                         xssqw($val)
  65.                     );
  66.       }
  67.     }
  68.     return $t;
  69.   }
  70.  
  71.   function _includeKey($key, $val) {
  72.     if (in_array($key, $this->excludes)) {
  73.       return false;
  74.     }
  75.     foreach ($this->excludesRegEx as $re) {
  76.       if (preg_match($re, $key)) {
  77.         return false;
  78.       }
  79.     }
  80.     foreach ($this->limitKeys as $seq => $lk) {
  81.       if (in_array($key, $lk)) {
  82.         // a restricted key; check that the key's value is OK
  83.         if (! in_array($val, $this->limitValues[$seq])) {
  84.           return false;
  85.         }
  86.       }
  87.     }
  88.     return true;
  89.   }
  90.  
  91.   /**
  92.   *  Exclude these fields from the reflection
  93.   *
  94.   * @param mixed  $arr single field or list of fields to exclude
  95.   */
  96.   function exclude($arr) {
  97.     if (! is_array($arr)) {
  98.       $this->excludes[] = $arr;
  99.     } else {
  100.       $this->excludes = array_merge($this->excludes, $arr);
  101.     }
  102.   }
  103.  
  104.   /**
  105.   *  Exclude the fields that match these regexps from the reflection
  106.   *
  107.   * @param mixed   $arr single regexp or list of regexps to use for exclusion
  108.   */
  109.   function excludeRegEx($arr) {
  110.     if (! is_array($arr)) {
  111.       $this->excludesRegEx[] = $arr;
  112.     } else {
  113.       $this->excludesRegEx = array_merge($this->excludesRegEx, $arr);
  114.     }
  115.   }
  116.  
  117.   function excludeLogin() {
  118.     $this->excludes[] = 'username';
  119.     $this->excludes[] = 'pass';
  120.     $this->excludes[] = 'magicTag';
  121.   }
  122.  
  123.   function addLimit($keys, $values) {
  124.     $this->limitKeys[] = $keys;
  125.     $this->limitValues[] = $values;
  126.   }
  127.  
  128. } // class DataReflector
  129.  
  130. ?>

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