Source for file anchortablelist.php

Documentation is available at anchortablelist.php

  1. <?php
  2. /**
  3. * Anchor list similar to AnchorList, but this time in a table not dot points
  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. *  path (bumblebee root)/inc/formslib/anchortablelist.php
  13. */
  14.  
  15. /** Load ancillary functions */
  16. require_once 'inc/typeinfo.php';
  17. checkValidInclude();
  18.  
  19. /** anchorlist parent object */
  20. require_once 'anchorlist.php';
  21. require_once 'bbstring.php';
  22.  
  23. /**
  24. * Anchor list similar to AnchorList, but this time in a table not dot points
  25. *
  26. * @package    Bumblebee
  27. * @subpackage FormsLibrary
  28. *
  29. */
  30. class AnchorTableList extends AnchorList {
  31.     /** @var integer  number of columns in the table*/
  32.     var $numcols    = '';
  33.     /** @var string   html/css class for the header row of the table */
  34.     var $headerRowClass = 'tableHeader';
  35.     /** @var string   html/css class for each row in the table  */
  36.     var $trclass    = 'itemrow';
  37.     /** @var string   html/css class for left-side table cell */
  38.     var $tdlclass   = 'itemL';
  39.     /** @var string   html/css class for right-side table cell */
  40.     var $tdrclass   = 'itemR';
  41.     /** @var string   html/css class for anchors */
  42.     var $aclass     = 'itemR';
  43.     /** @var string   html/css class for entire table */
  44.     var $tableclass = 'selectlist';
  45.     /** @var array    list of table headings to be put at the top of the table */
  46.     var $tableHeading;
  47.     /** @var boolean  make all columns in the table link to the target URL not just the first */
  48.     var $linkAll = true;
  49.     /** @var boolean  controls the generation of header links to sort the table by */
  50.     var $useSortByHeadings = false;
  51.     /** @var string   tells which header to sort by. null for default. This value will be
  52.      *  superseeded by the sortby paramater in connectDB */
  53.     var $defaultSortByHeading = 'name';
  54.     /** @var array    data source from which the column to sort by will be read */
  55.     var $data = null;
  56.     /** @var string   key in $data in which the column name should be stored */
  57.     var $sortbyKey;
  58.  
  59.     /**
  60.     *  Create a new AnchorTableList
  61.     *
  62.     * @param string $name   the name of the field (db name, and html field name
  63.     * @param string $description  used in the html title of the list
  64.     * @param integer $numcols (optional) number of columns in the table
  65.     */
  66.     function AnchorTableList($name, $description='', $numcols=2) {
  67.       $this->AnchorList($name, $description);
  68.       $this->numcols = $numcols;
  69.       $this->sortbyKey = $this->name.'_sortby';
  70.     } //end function AnchorTableList
  71.  
  72.     
  73.     /**
  74.     *  Accessor method to set the table column headings
  75.     *
  76.     * @param array   new headings to use for the table
  77.     */
  78.     function setTableHeadings($headings) {
  79.  
  80.       $this->tableHeadings = $headings;
  81.  
  82.     } //end function setTableHeadings
  83.  
  84.     
  85.     /**
  86.      * Sets which heading to sort by
  87.      *
  88.      * @param boolean turn the sort by links on and off
  89.      * @param array   data source to find which heading to sort by
  90.      * @param string  (optional) the default heading to sort by
  91.      *
  92.      */
  93.     function sortByHeadings($sort, $data, $heading = 'name') {
  94.       $this->useSortByHeadings = $sort;
  95.       $this->data = $data;
  96.       $this->defaultSortByHeading = $heading;
  97.     } //end function sortByHeadings
  98.  
  99.     
  100.     function format($data) {
  101.       //preDump($this);
  102.       $aclass  = (isset($this->aclass) ? " class='$this->aclass'" : '');
  103.       $trclass  = (isset($this->trclass) ? " class='$this->trclass'" : '');
  104.       $tdlclass  = (isset($this->tdlclass) ? " class='$this->tdlclass'" : '');
  105.       $tdrclass  = (isset($this->tdrclass) ? " class='$this->tdrclass'" : '');
  106.       $linkformat = "<a href='".str_replace('__id__', $data[$this->formatid], $this->hrefbase)."'$aclass>"
  107.           ."%s</a>";
  108.       $t  = "<tr $trclass>"
  109.           ."<td $tdlclass>";
  110.       $t .= sprintf($linkformat, $this->formatter[0]->format($data));
  111.       $t .= "</td>\n";
  112.  
  113.       for ($i=2; $i<=$this->numcols; $i++) {
  114.  
  115.         $t .= "<td $tdrclass>";
  116.  
  117.         if ($this->linkAll) {
  118.             $t .= sprintf($linkformat, $this->formatter[$i-1]->format($data));
  119.         } else {
  120.             $t .= $this->formatter[$i-1]->format($data);
  121.         } //end if-else
  122.  
  123.           $t .= "</td>";
  124.       } //end for
  125.  
  126.       $t .= "</tr>\n";
  127.       return $t;
  128.     } //end function format
  129.  
  130.     
  131.     function display() {
  132.       $tableclass = (isset($this->tableclass) ? " class='$this->tableclass'" : '');
  133.       $t  = "<table title='$this->description' $tableclass>\n";
  134.  
  135.       if (isset($this->tableHeadings)) {
  136.  
  137.         $t .= "<tr class='{$this->headerRowClass}'>";
  138.  
  139.         if(! $this->useSortByHeadings) {
  140.           foreach ($this->tableHeadings as $heading) {
  141.  
  142.             if(type_is_a($heading, 'bbString')) {
  143.                 $t .='<th>'.$heading->getExternalRep().'</th>';
  144.  
  145.             } else {
  146.                 $t .= "<th>$heading</th>";
  147.             } //end if-else
  148.           } //end foreach
  150.         } else {
  151.  
  152.           $aclass = (isset($this->aclass) ? " class='{$this->aclass}'" : '');
  153.  
  154.           foreach($this->tableHeadings as $heading) {
  155.             $text   = type_is_a($heading, 'bbString')
  156.                                         ? $heading->getExternalRep() : $heading;
  157.             $sortby = type_is_a($heading, 'bbString')
  158.                                         ? $heading->getInternalRep() : $heading;
  159.             $href = str_replace('__sortby__', $sortby, $this->sortByHref);
  160.  
  161.             $t .=  "<th><a href='".$href."' $aclass title='".T_('Sort by this column')."'>".$text.'</a></th>';
  162.           } //end foreach
  164.         } //end if-else
  166.         $t .= "</tr>\n";
  167.       } //end if
  169.       if (is_array($this->list->choicelist)) {
  170.         foreach ($this->list->choicelist as $v) {
  171.           $t .= $this->format($v);
  172.         } //end foreach
  173.       } //end if
  175.       $t .= "</table>\n";
  176.       return $t;
  177.     } //end function display()
  179.     /**
  180.     *  overloading of ChoiceList's connectDB to allow for remembering the
  181.     *     sortby column
  182.     */
  183.     function connectDB($table, $fields = '', $restriction = '', $order = 'name',
  184.             $idfield = 'id', $limit = '', $join = '', $distinct = false) {
  185.  
  186.       if ($this->useSortByHeadings) {
  187.         $order = q(issetSet($this->data, $this->sortbyKey, $this->defaultSortByHeading));
  188.       }
  189.       parent::connectDB($table, $fields, $restriction, $order, $idfield, $limit,
  190.                     $join, $distinct);
  191.  
  192.     } //end function connectDB
  194. } // class AnchorList

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