File Source for Table.php

<?php
/**
* CNZ Framework
*
* A Framework for Creating and Using Complex Web Elements
*
* The purpose of this framework is to provide a library of high-level objects
* to facilitate common HTML coding tasks, such as menus, tables, and forms.
* The intent is to reduce repetitive HTML coding as much as possible, replacing
* it with a combination of configuration files and style sheets with
* standardized naming conventions.
*
* This framework is built on and requires the
* {@link http://framework.zend.com/ Zend Framework}.
*
* @category Cnz
* @package Cnz_Html
* @subpackage Table
*
* @author Lyle Frost <lfrost@cnz.com>
* @copyright Copyright (c) 2006-2007 Citadel Network <{@link http://www.citadelnetwork.com/}>
* @filesource
* @license http://www.citadelnetwork.com/license/cnzframework New BSD License
* @version $Id: Table.php 27 2007-07-19 18:47:54Z lfrost $
*/
/**
* Required classes.
*
* @ignore
*/
Zend_Loader::loadClass('Cnz_Html_Element');
Zend_Loader::loadClass('Cnz_Html_Table_Button');
Zend_Loader::loadClass('Cnz_Html_Table_Column');
Zend_Loader::loadClass('Zend_Filter');
Zend_Loader::loadClass('Zend_Filter_Alnum');
Zend_Loader::loadClass('Zend_Filter_Int');
/**
* HTML Table class
*
* If greenbar is true, the style suffix 'hilight' is used for even-numbered
* rows.
*
* Example INI:
*
* <pre><samp>
* [HtmlTable]
* greenbar = true
* greenbarBandSize = 2
*
*
* [HtmlTable-team : HtmlTable]
* caption = "The CF Demo Team"
* order = number:desc
*
* column.1.name = name
* column.1.heading = Name
*
* column.2.name = number
* column.2.heading = Number
* column.2.align = right
* column.2.type = int
*
* column.3.name = position
* column.3.heading = Position
*
*
* [HtmlTable-directory : HtmlTable]
* from = employee
* order = name_last,name_first
* limit = 8
*
* column.name.heading = Name
* column.name.name = name
* column.name.expression = "name_first||' '||name_last"
*
* column.email.heading = Email
* column.email.name = email
* column.email.link = mailto
* </samp></pre>
*
* Example PHP:
*
* <code>
* Cnz_Html::loadAndDisplay('Cnz_Html_Table_Csv', array('name' => 'team', 'filename' => 'table.ini', 'config' => true), 'float:right;');
* $teamTable->display();
* </code>
*
* @category Cnz
* @package Cnz_Html
* @subpackage Table
*/
class Cnz_Html_Table extends Cnz_Html_Element implements Countable
{
const HAS_CONFIG = true;
const PREFIX = 'HtmlTable';
const BUTTON_PREFIX = 'button';
const COLUMN_PREFIX = 'column';
const ITEM_PREFIX = 'item';
const DEFAULT_LIMIT = 24;
const FIRST_BUTTON = 'first.png';
const LAST_BUTTON = 'last.png';
const NEXT_BUTTON = 'next.png';
const PREV_BUTTON = 'prev.png';
const ORDER_ASC = 'asc';
const ORDER_DESC = 'desc';
/**#@+ @var array */
protected $columnArray = array();
protected $buttonArray = array();
protected $rowArray = array();
protected $orderArray = array();
/**#@-*/
/**#@+ @var int */
protected $limit = NULL;
protected $offset = 0;
protected $rowCount = 0;
protected $pageCount = 0;
protected $pageNumber = 0;
/**#@-*/
/**#@+ @var string */
protected $whereAdd = NULL;
/**#@-*/
/*====================================================================*/
/**#@+ @var boolean */
private $headerRowFlag = false;
private $greenbarFlag = false;
/** Records are in columns */
private $transposeFlag = false;
/**#@-*/
/**#@+ @var int */
private $greenbarBandSize = 1;
/**#@-*/
/**#@+ @var string */
private $caption = NULL;
/**#@-*/
/* Getters/Setters ===================================================*/
/**
* @param string New order
* @return void
*/
public function setOrderBy($order)
{
$this->orderArray = Cnz_Html::listToArray($order);
return;
}
/* Generators ========================================================*/
/**
* @return array Sequential array of column names
*/
protected function genColumnNameArray()
{
$cna = array();
foreach ($this->columnArray as $column)
{
$cna[] = $column->getName();
}
return $cna;
}
/* Methods ===========================================================*/
/**
* Option fields:
* none
*
* Configuration fields:
* caption
* greenbar
* greenbarBandSize
* limit
* order
*
* @param array $options Options
*/
public function __construct(array $options = array())
{
parent::__construct($options);
// Process configuration.
if (isset($this->config->caption)) $this->caption = $this->config->caption;
if (isset($this->config->greenbar)) $this->greenbarFlag = Cnz_Html::configFlag($this->config->greenbar);
if (isset($this->config->greenbarBandSize)) $this->greenbarBandSize = (int)$this->config->greenbarBandSize;
if (isset($this->config->limit)) $this->limit = (int)$this->config->limit;
if (isset($this->config->order)) $this->orderArray = Cnz_Html::listToArray($this->config->order);
// Create buttons and columns.
$i = 0;
if (isset($this->config->column))
{
for ($this->config->column->rewind(); $this->config->column->valid(); $this->config->column->next())
{
$options['name'] = $this->config->column->key();
$this->columnArray[$i++] = new Cnz_Html_Table_Column($options, $this->config->column->current());
}
}
$i = 0;
if (isset($this->config->button))
{
for ($this->config->button->rewind(); $this->config->button->valid(); $this->config->button->next())
{
$options['name'] = $this->config->button->key();
$this->buttonArray[$i++] = new Cnz_Html_Table_Button($options, $this->config->button->current());
}
}
// Process _GET.
if (isset($_GET['offset']))
{
$filter = new Zend_Filter_Int();
$this->offset = $filter->filter($_GET['offset']);
}
if (isset($_GET['order']))
{
$filter = new Zend_Filter_Alnum();
$order = $filter->filter($_GET['order']);
if (!empty($order)) $this->orderArray = Cnz_Html::listToArray($order);
}
if (isset($_GET['where']))
{
$filter = new Zend_Filter_Alnum();
$this->whereAdd = $filter->filter($_GET['where']);
}
return;
}
/**
* @param string $style Value for outermost style attribute
* @return void
*/
public function display($style = NULL)
{
$this->readData();
//if (!empty($this->whereAdd)) echo '<p>', $this->whereAdd, '</p>';
$indent = Cnz_Html::indentGenerate();
echo $indent, '<div class = "', $this->genStyles(), '"';
if (!empty($style)) echo ' style = "', $style, '"';
echo '>', "\n";
Cnz_Html::indentInc();
$indent = Cnz_Html::indentGenerate();
echo $indent, '<table class = "', $this->genStyles(), '" style = "width:100%;">', "\n";
Cnz_Html::indentInc();
$indent = Cnz_Html::indentGenerate();
if (isset($this->caption))
{
echo $indent, '<caption class = "', $this->genStyles(), '">';
echo $this->caption;
echo '</caption>', "\n";
}
if (count($this->columnArray) > 0)
{
$this->displayHeader();
}
$rowCount = count($this->rowArray);
for ($rowNumber = 0; $rowNumber < $rowCount; $rowNumber++)
{
$this->displayRow($rowNumber);
}
Cnz_Html::indentDec();
$indent = Cnz_Html::indentGenerate();
echo $indent, '</table>', "\n";
// Paging controls.
if (isset($this->limit))
{
echo $indent, '<div style = "text-align: center;">';
$next_offset = $this->offset + $this->limit;
$prev_offset = $this->offset - $this->limit;
if ($prev_offset >= 0)
{
// first button
echo '<a href = ""><img alt = "[First]" src = "', Cnz_Html::getButtonDir(), self::FIRST_BUTTON, '" style = "border:none;"/></a>';
// prev button
echo '<a href = "?offset=' . $prev_offset;
echo '&order=', Cnz_Html::arrayToList($this->orderArray);
echo '"><img alt = "[Previous]" src = "', Cnz_Html::getButtonDir(), self::PREV_BUTTON, '" style = "border:none;"/></a> ';
}
echo 'Page ', $this->pageNumber, ' of ', $this->pageCount;
if ($this->pageNumber < $this->pageCount)
{
echo ' <a href = "?offset=' . $next_offset;
echo '&order=', Cnz_Html::arrayToList($this->orderArray);
echo '"><img alt = "[Next]" src = "', Cnz_Html::getButtonDir(), self::NEXT_BUTTON, '" style = "border:none;"/></a>';
echo '<a href = "?offset=', ($this->pageCount - 1) * $this->limit;
echo '&order=', Cnz_Html::arrayToList($this->orderArray);
echo '"><img alt = "[Last]" src = "', Cnz_Html::getButtonDir(), self::LAST_BUTTON, '" style = "border:none;"/></a>';
}
echo '</div>', "\n";
}
Cnz_Html::indentDec();
$indent = Cnz_Html::indentGenerate();
echo $indent, '</div>', "\n";
return;
}
protected function readData()
{
}
/**
* @param string $name Column name
* @return int Column number, or false on error
*/
protected function columnNameToNumber($name)
{
$n = count($this->columnArray);
for ($i = 0; $i < $n; $i++)
{
if ($name == $this->columnArray[$i]->getName()) return $i;
}
return false;
}
/**
* Defined by the Countable interface
*
* @return int
*/
public function count()
{
return count($this->rowArray);
}
/**
* @return void
*/
private function displayHeader()
{
$is = Cnz_Html::getIndentString();
$indent = Cnz_Html::indentGenerate();
echo $indent, '<tr class = "', $this->genStyles(), '">', "\n";
if (count($this->buttonArray) > 0) echo $indent, $is, '<th class = "', $this->genStyles(), '"> </th>', "\n";
$colNumber = 0;
foreach ($this->columnArray as $column)
{
echo $indent, $is, '<th class = "', $this->genStyles(), '">';
$order = $column->getOrder();
if (!empty($order))
{
echo '<a href = "?offset=', $this->offset, '&order=', $order, '">';
echo $column->getHeading();
echo '</a>';
}
else
{
echo $column->getHeading();
}
echo '</th>', "\n";
}
echo $indent, '</tr>', "\n";
return;
}
/**
* @return void
*/
private function displayRow($rowNumber)
{
$is = Cnz_Html::getIndentString();
$indent = Cnz_Html::indentGenerate();
$bandNum = 0;
if ($this->greenbarFlag)
{
$bandNum = (int)($rowNumber / $this->greenbarBandSize);
}
echo $indent, '<tr class = "', $this->genStyles(), '">', "\n";
if ($this->transposeFlag)
{
echo $indent, $is, '<th class = "', $this->genStyles(), '">', "\n";
echo $this->columnArray[$rowNumber]->getHeading();
echo '</th>', "\n";
}
// Greenbar
$styleSuffix = '';
if ($this->greenbarFlag)
{
if ($bandNum % 2 == 1) $styleSuffix = 'hilight';
}
$row = $this->rowArray[$rowNumber];
// Buttons
if (count($this->buttonArray) > 0)
{
echo $indent, $is, '<td class = "', $this->genStyles(NULL, $styleSuffix), '">', "\n";
foreach ($this->buttonArray as $button)
{
$button->setRow($row);
$button->display();
}
echo $indent, $is, '</td>', "\n";
}
$colCount = count($this->columnArray);
for ($colNum = 0; $colNum < $colCount; $colNum++)
{
$style = '';
$column = $this->columnArray[$colNum];
$align = $column->getAlign();
$colName = $this->columnArray[$colNum]->getName();
if (!empty($align)) $style = ' style = "text-align:' . $align . ';"';
$cell = $row[$colName];
echo $indent, $is, '<td class = "', $this->genStyles(NULL, $styleSuffix), '"', $style;
if ($column->getNoWrap()) echo ' style = "white-space:nowrap;"';
echo '>';
$link = $column->getLink();
if (!empty($link) && !empty($cell))
{
echo '<a href = "';
switch ($link)
{
case 'web':
echo 'http://';
break;
case 'weblocal':
break;
case 'mail':
case 'mailto':
echo 'mailto:';
break;
default:
// error
break;
}
echo $cell, '">';
echo $cell;
echo '</a>';
}
else echo $cell;
echo '</td>', "\n";
}
echo $indent, '</tr>', "\n";
return;
}
}

Source for file Table.php