Source for file bitmask.php

Documentation is available at bitmask.php

  1. <?php
  2. /**
  3. * a table of checkboxes for different options that are condensed into a single value by bitmask
  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: bitmask.php,v 1.3 2006/10/10 19:44:35 themill Exp $
  9. * @package    Bumblebee
  10. * @subpackage FormsLibrary
  11. */
  12.  
  13. /** Load ancillary functions */
  14. require_once 'inc/typeinfo.php';
  15. checkValidInclude();
  16.  
  17. /** parent object */
  18. require_once 'textfield.php';
  19. /** uses checkbox table list */
  20. require_once 'checkboxtablelist.php';
  21.  
  22. // ===================  NOTE  ======================
  23. // $this->select suffers from a horrible hack around a PHP 4.x bug
  24. // All we want to do is something like:
  25. //    $this->select->foo($a);
  26. // but that causes $this->select to suddenly become a reference: Object not &Object (see a var_dump)
  27. // see http://bugs.php.net/bug.php?id=24485 and http://bugs.php.net/bug.php?id=30787
  28. // There is no prospect of this bug ever being fixed in PHP4.
  29. // If we can come up with a clone() function for PHP4 that deals with references then
  30. // we can at least get rid of some of these horrible hacks:
  31. //     $s = $this->select;
  32. //     $s->foo($a);
  33. //     $this->select = $s;
  34. // ================================================
  35.  
  36.  
  37. /**
  38. * a table of checkboxes for different options that are condensed into a single value by bitmask
  39. *
  40. * @package    Bumblebee
  41. * @subpackage FormsLibrary
  42. */
  43. class Bitmask extends TextField {
  44.   /** @var boolean  show "expand" and "collapse" links */
  45.   var $showHideButtons = false;
  46.  
  47.   /** @var CheckBoxTableList   the actual check box list that will be shown */
  48.   var $select;
  49.  
  50.   /** @var integer  number of columns in the table  */
  51.   var $numcols    = '';
  52.   /** @var integer  number of extra columns to be added to the table  */
  53.   var $numExtraInfoCols = '';
  54.   /** @var string   html/css class for each row in the table  */
  55.   var $trclass    = 'itemrow';
  56.   /** @var string   html/css class for left-side table cell */
  57.   var $tdlclass   = 'itemL';
  58.   /** @var string   html/css class for right-side table cell */
  59.   var $tdrclass   = 'checkBoxEntry';
  60.   /** @var string   html/css class for entire table */
  61.   var $tableclass = 'selectlist';
  62.   /** @var array    list of table headings to be put at the top of the table */
  63.   var $tableHeading;
  64.   /** @var array    list of strings to be included in the footer of the table */
  65.   var $footer;
  66.   /** @var boolean  generate select/deselect links at the bottom of each column */
  67.   var $includeSelectAll = false;
  68.  
  69.   /**
  70.   *  Create a new BitmaskPopup
  71.   *
  72.   * @param string $name   the name of the field (db name, and html field name
  73.   * @param string $description  used in the html title of the list
  74.   */
  75.   function Bitmask($name, $title, $description='', $checkbox_description) {
  76.     parent::TextField($name, $title, $description);
  77.     // $this->DEBUG=10;
  78.     $select = new CheckBoxTableList($name); // see note above before refactoring $select out
  79.     $bit = new CheckBox('bit', $checkbox_description);
  80.     $hidden = new TextField('value');
  81.     $select->addFollowHidden($hidden);
  82.     $select->addCheckBox($bit);
  83.     $select->setFormat('id', '%s', array('iv'));
  84.     $select->addSelectAllFooter(true);
  85.     $this->select = $select;
  86.     $this->numcols=1;
  87.   }
  88.  
  89.   /**
  90.   * Provides a set of values for the droplist rather than filling it from a db query
  91.   *
  92.   * cf. ChoiceList::connectDB
  93.   *
  94.   * @param array $list List of label=>value pairs
  95.   */
  96.   function setValuesArray($list, $idfield='id', $valfield='iv'){
  97.     $s = $this->select;   // see note above for why we have this horrible hack
  98.     $s->setValuesArray($list, $idfield, $valfield);
  99.     $this->select = $s;
  100.   }
  101.  
  102.   /**
  103.   *  Accessor method to set the table column headings
  104.   *
  105.   * @param array   new headings to use for the table
  106.   */
  107.   function setTableHeadings($headings) {
  108.     $s = $this->select;   // see note above for why we have this horrible hack
  109.     $s->tableHeadings = $headings;
  110.     $this->select = $s;
  111.   }
  112.  
  113.   function update($data) {
  114.     #echo "Name=({$this->namebase},{$this->name})<br />";
  115.     $value = 0;
  116.     $fieldSet = false;
  117.     $s = $this->select;   // see note above for why we have this horrible hack
  118.     $s->namebase = $this->namebase;
  119.     $s->MakeBoxMatrix();
  120.     for ($i=0; $i<count($s->list->choicelist); $i++) {
  121.       $fieldname  = $s->boxMatrix[$i][0]->namebase . $s->boxMatrix[$i][0]->name;
  122.       $fieldvalue = $s->boxMatrix[$i][0]->namebase . 'value';
  123.       #echo "/$fieldname/$fieldvalue/";
  124.       if (isset($data[$fieldname]) && isset($data[$fieldvalue])) {
  125.         $value |= $data[$fieldvalue];
  126.         $fieldSet = true;
  127.         #echo "(set)";
  128.         #echo "('$data[$fieldname]')";
  129.       }
  130.       #echo $data[$fieldvalue];
  131.       #echo "#$value<br />";
  132.     }
  133.     if ($fieldSet) {
  134.       $data[$this->namebase.$this->name] = $value;
  135.     }
  136.     $this->select = $s;
  137.  
  138.     //$this->select->update($data);
  139.     if (parent::update($data)) {
  140.       $this->setChecks($value);
  141.     }
  142.     return $this->changed;
  143.   }
  144.  
  145.   function set($value) {
  146.     #echo "Set Name=({$this->namebase},{$this->name})<br />";
  147.     parent::set($value);
  148.     $s = $this->select;
  149.     $s->namebase = $this->namebase;
  150.     $s->MakeBoxMatrix();
  151.     $this->select = $s;
  152.     $this->setChecks($value);
  153.   }
  154.  
  155.   function setChecks($value) {
  156.     for ($i=0; $i<count($this->select->list->choicelist); $i++) {
  157.       #echo "Setting $i, $value => ";
  158.       #echo $this->select->boxMatrix[$i][0]->namebase;
  159.       $this->select->boxMatrix[$i][0]->value =
  160.           ($value & $this->select->list->choicelist[$i]['id'])
  161.                  == $this->select->list->choicelist[$i]['id'];
  162.       #echo $this->select->list->choicelist[$i]['id'] . " " . $this->select->boxMatrix[$i][0]->value;
  163.       #echo "<br />";
  164.     }
  165.   }
  166.  
  167.   /**
  168.   * embed the html within a div to enable some creative js folding
  169.   *
  170.   * @return string  html snippet that will open a new window with the html report
  171.   */
  172.   function wrapHTMLBuffer($contents) {
  173.     if (! $this->showHideButtons) return $contents;
  174.  
  175.     $id = preg_replace('/[^\w]/', '_', $this->namebase.$this->name);
  176.     $func = "toggle$id";
  177.  
  178.     $jsbuf = "
  179.     <div class='collapsecontrol' id='show$id' style='display: none;'><a href='javascript:$func(true)'>"
  180.                   .T_('expand')."</a></div>
  181.     <div class='collapsecontrol' id='hide$id' style='display: none;'><a href='javascript:$func(false)'>"
  182.                   .T_('collapse')."</a></div>
  183.     <div id='table$id'>$contents</div>
  184.     <script type='text/javascript'>
  185.       function $func(show) {
  186.         if (show) {
  187.           var id1 = document.getElementById('show$id');
  188.           id1.style.display = 'none';
  189.           var id2 = document.getElementById('hide$id');
  190.           id2.style.display = 'block';
  191.           var id3 = document.getElementById('table$id');
  192.           id3.style.display = 'inline';
  193.         } else {
  194.           var id1 = document.getElementById('show$id');
  195.           id1.style.display = 'block';
  196.           var id2 = document.getElementById('hide$id');
  197.           id2.style.display = 'none';
  198.           var id3 = document.getElementById('table$id');
  199.           id3.style.display = 'none';
  200.         }
  201.       }
  202.       $func(false);
  203.     </script>
  204.       ";
  205.     return $jsbuf;
  206.   }
  207.  
  208.   function displayInTable($numCols=3) {
  209.     #preDump($this->select);
  210.     $this->select->numcols    = $this->numcols;
  211.     $this->select->numExtraInfoCols = $this->numExtraInfoCols;
  212.     $this->select->trclass    = $this->trclass;
  213.     $this->select->tdlclass   = $this->tdlclass;
  214.     $this->select->tdrclass   = $this->tdrclass;
  215.     $this->select->tableclass = $this->tableclass;
  216.     $this->select->tableHeading = $this->tableHeading;
  217.     $this->select->footer     = $this->footer;
  218. //     $this->select->includeSelectAll = $this->includeSelectAll;
  219.  
  220.     $tableclass = (isset($this->tableclass) ? " class='$this->tableclass'" : "");
  221.     $t  = #'<html><head></head><body>'
  222.          #.
  223.          "<table title='{$this->description}' $tableclass>\n"
  224.          .$this->select->displayInTable($this->numcols)
  225.          ."</table>";#</body></html>\n";
  226.     $enc = $this->wrapHTMLBuffer($t);
  227.     return "<tr><td>{$this->longname}</td><td>$enc</td></tr>\n";
  228.   }
  229.  
  230.   /**
  231.   * PHP5 clone method
  232.   *
  233.   * PHP5 clone statement will perform only a shallow copy of the object. Any subobjects must also be cloned
  234.   */
  235.   function __clone() {
  236.     //echo "<hr /><br />Cloning bitmask<br />";
  237.     // Force a copy of contents of $this->list
  238.     if (is_object($this->select)) $this->select = clone($this->select);
  239.   }
  240.  
  241. } // class Bitmask
  243.  

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