Source for file outputformatter.php

Documentation is available at outputformatter.php

  1. <?php
  2. /**
  3. * Output formatter object that controls output of other objects with sprintf statements
  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. * Output formatter object that controls output of other objects with sprintf statements
  19. *
  20. * @package    Bumblebee
  21. * @subpackage FormsLibrary
  22. */
  23. class OutputFormatter {
  24.   /** @var string  sprintf format string for this formatter  */
  25.   var $format;
  26.   /** @var mixed   field name or array of names (keys to $data) to format using this formatter */
  27.   var $formatfields;
  28.  
  29.  /**
  30.   *  Create a new OutputFormatter object
  31.   *
  32.   * @param string $format  see $this->format
  33.   * @param mixed $fields  string or array, see $this->fields
  34.   */
  35.    function OutputFormatter($format, $fields) {
  36.     $this->format = $format;
  37.     $this->formatfields = $fields;
  38.   }
  39.  
  40.   /**
  41.   * Format the data
  42.   *
  43.   * @param array $data     data to be formatted, $data[$formatfields[$i]]
  44.   * @return string formatted data
  45.   */
  46.   function format($data) {
  47.     #echo "Formatting string";
  48.     $fields = is_array($this->formatfields) ? $this->formatfields : array($this->formatfields);
  49.     $s = array();
  50.     foreach ($fields as $v) {
  51.       if (! is_object($v)) {
  52.         if (isset($data[$v])) {
  53.           $val = isset($data[$v]) ? xssqw($data[$v]) : '';
  54.           if ($val !== '' && $val !== NULL) $s[] = $val;
  55.         }
  56.       } else {
  57.         $val = $v->format($data);
  58.         if ($val !== '' && $val !== NULL) $s[] = $val;
  59.       }
  60.     }
  61.     return count($s) ? vsprintf($this->format, $s) : '';
  62.   }
  63.  
  64. } // class OutputFormatter
  65.  
  66. ?>

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