/usr/share/php/Structures/DataGrid/Renderer/HTMLTable.php is in php-structures-datagrid-renderer-htmltable 0.1.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 | <?php
/**
* HTML Table Rendering Driver
*
* PHP versions 4 and 5
*
* LICENSE:
*
* Copyright (c) 1997-2007, Andrew Nagy <asnagy@webitecture.org>,
* Olivier Guilyardi <olivier@samalyse.com>,
* Mark Wiesemann <wiesemann@php.net>
* Sascha Grossenbacher <saschagros@bluewin.ch>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * The names of the authors may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* CSV file id: $Id: HTMLTable.php 250761 2008-01-16 17:07:28Z wiesemann $
*
* @version $Revision: 250761 $
* @package Structures_DataGrid_Renderer_HTMLTable
* @category Structures
* @license http://opensource.org/licenses/bsd-license.php New BSD License
*/
require_once 'Structures/DataGrid/Renderer.php';
require_once 'HTML/Table.php';
/**
* HTML Table Rendering Driver
*
* Driver for rendering the DataGrid as an HTMLTable
*
* SUPPORTED OPTIONS:
*
* - evenRowAttributes: (array) An associative array containing each attribute
* of the even rows.
* - oddRowAttributes: (array) An associative array containing each attribute
* of the odd rows.
* - emptyRowAttributes: (array) An associative array containing the attributes
* for empty rows.
* - selfPath: (string) The complete path for sorting and paging links.
* (default: $_SERVER['PHP_SELF'])
* - sortIconASC: (string) The icon to define that sorting is currently
* ascending. Can be text or HTML to define an image.
* - sortIconDESC: (string) The icon to define that sorting is currently
* descending. Can be text or HTML to define an image.
* - classASC: (string) A CSS class name for TH elements to define that
* sorting is currently ascending.
* - classDESC: (string) A CSS class name for TH elements to define that
* sorting is currently descending.
* - headerAttributes: (array) Attributes for the header row. This is an array
* of the form: array(attribute => value, ...)
* - convertEntities: (bool) Whether or not to convert html entities.
* This calls htmlspecialchars().
* - sortingResetsPaging: (bool) Whether sorting HTTP queries reset paging.
*
* SUPPORTED OPERATION MODES:
*
* - Container Support: yes
* - Output Buffering: yes
* - Direct Rendering: no
* - Streaming: no
* - Object Preserving: no
*
* @version $Revision: 250761 $
* @example ajax-simple.php Simple AJAX support using the Prototype framework
* @author Andrew S. Nagy <asnagy@webitecture.org>
* @author Olivier Guilyardi <olivier@samalyse.com>
* @author Mark Wiesemann <wiesemann@php.net>
* @author Sascha Grossenbacher <saschagros@bluewin.ch>
* @access public
* @package Structures_DataGrid_Renderer_HTMLTable
* @category Structures
*/
class Structures_DataGrid_Renderer_HTMLTable extends Structures_DataGrid_Renderer
{
/**
* Rendering container
* @var object HTML_Table object
* @access protected
*/
var $_table;
/**
* The html_table_storage object for the table header
* @var object HTML_Table_Storage
*/
var $_tableHeader;
/**
* The html_table_storage object for the table body
* @var object HTML_Table_Storage
*/
var $_tableBody;
/**
* The body row index to start rendering at
* @var int
*/
var $_bodyStartRow;
/**
* Constructor
*
* Build default values
*
* @access public
*/
function Structures_DataGrid_Renderer_HTMLTable()
{
parent::Structures_DataGrid_Renderer();
$this->_addDefaultOptions(
array(
'evenRowAttributes' => array(),
'oddRowAttributes' => array(),
'emptyRowAttributes' => array(),
'selfPath' => htmlspecialchars($_SERVER['PHP_SELF']),
'sortIconASC' => '',
'sortIconDESC' => '',
'classASC' => '',
'classDESC' => '',
'headerAttributes' => array(),
'convertEntities' => true,
'sortingResetsPaging' => true,
)
);
$this->_setFeatures(
array(
'outputBuffering' => true,
)
);
}
/**
* Attach an already instantiated HTML_Table object
*
* @var object HTML_Table object
* @return mixed True or PEAR_Error
* @access public
*/
function setContainer(&$table)
{
$this->_table =& $table;
return true;
}
/**
* Return the currently used HTML_Table object
*
* @return object HTML_Table (reference to) or PEAR_Error
* @access public
*/
function &getContainer()
{
isset($this->_table) or $this->init();
return $this->_table;
}
/**
* Instantiate the HTML_Table container if needed, and set it up
*
* @access protected
*/
function init()
{
if (!isset($this->_table)) {
$this->_table = new HTML_Table(null, null, true);
}
$this->_tableHeader =& $this->_table->getHeader();
$this->_tableBody =& $this->_table->getBody();
$this->_bodyStartRow = $this->_tableBody->getRowCount();
}
/**
* Set a table attribute
*
* @deprecated Use the HTML_Table constructor directly instead
* @access public
* @param string $attr The name of the attribute.
* @param string $value The value of the attribute.
*/
function setTableAttribute($attr, $value)
{
if (is_null($this->_table)) {
$this->init();
}
$this->_table->updateAttributes(array($attr => $value));
}
/**
* Define the table's header row attrbiutes
*
* @access public
* @param array $attribs The attributes for the table header row.
*/
function setTableHeaderAttributes($attribs)
{
$this->_options['headerAttributes'] = $attribs;
}
/**
* Define the table's odd row attributes
*
* @access public
* @param array $attribs The associative array of attributes for the
* odd table row.
* @see HTML_Table::setCellAttributes
*/
function setTableOddRowAttributes($attribs)
{
$this->_options['oddRowAttributes'] = $attribs;
}
/**
* Define the table's even row attributes
*
* @access public
* @param array $attribs The associative array of attributes for the
* even table row.
* @see HTML_Table::setCellAttributes
*/
function setTableEvenRowAttributes($attribs)
{
$this->_options['evenRowAttributes'] = $attribs;
}
/**
* Define the table's autofill value. This value appears only in an empty
* table cell.
*
* @access public
* @param string $value The value to use for empty cells.
*/
function setAutoFill($value)
{
if (is_null($this->_table)) {
$this->init();
}
$this->_tableBody->setAutoFill($value);
}
/**
* In order for the DataGrid to render "Empty Rows" to allow for uniformity
* across pages with varying results, set this option to true. An example
* of this would be when you have 11 results and have the DataGrid show 10
* records per page. The last page will only show one row in the table,
* unless this option is turned on in which it will render 10 rows, 9 of
* which will be empty.
*
* @access public
* @param bool $value A boolean value to determine whether or
* not to display the empty rows.
* @param array $attributes The empty row attributes defined in an
* array.
*/
function allowEmptyRows($value, $attributes = array())
{
$this->_options['fillWithEmptyRows'] = (bool)$value;
$this->_options['emptyRowAttributes'] = $attributes;
}
/**
* Determines whether or not to use the Header
*
* @deprecated Use the "buildHeader" option instead
* @access public
* @param bool $bool value to determine to use the header or not.
*/
function useHeader($bool)
{
$this->_options['buildHeader'] = (bool)$bool;
}
/**
* Add custom GET variables to the generated links
*
* This method adds the provided variables to the paging and sorting
* links. The variable values are automatically url encoded.
*
* @deprecated Use the "extraVars" option instead
* @param array $vars Array of the form (key => value, ...)
* @access public
* @return void
*/
function setExtraVars($vars)
{
$this->_options['extraVars'] = $vars;
}
/**
* Exclude GET variables from the generated links
*
* This method excludes the provided variables from the paging and sorting
* links. This is helpful when using variables that determine what page to
* show such as an 'action' variable, etc.
*
* @deprecated Use the "excludeVars" option instead
* @param array $vars An array of variables to remove
* @access public
* @return void
*/
function excludeVars($vars)
{
$this->_options['excludeVars'] = $vars;
}
/**
* Generates the HTML for the DataGrid
*
* @deprecated Use getOutput() instead.
* @access public
* @return string The HTML of the DataGrid
* @see Structures_DataGrid_Renderer::getOutput
*/
function toHTML()
{
return $this->getOutput();
}
/**
* Gets the HTML_Table object for the DataGrid
*
* @deprecated Use getContainer() instead.
* @access public
* @return object HTML_Table The HTML Table object for the DataGrid
*/
function &getTable()
{
return $this->_table;
}
/**
* Handles building the header of the DataGrid
*
* @param array $columns Columns' fields names and labels
* @access protected
* @return void
* @see http://www.php.net/manual/en/function.http-build-query.php
*/
function buildHeader(&$columns)
{
$row = $this->_tableHeader->getRowCount();
foreach ($columns as $col => $spec) {
$field = $spec['field'];
$label = $spec['label'];
$cssClass = '';
// Define Content
if (in_array($field, $this->_sortableFields)) {
// Determine next sort direction and current sort icon
reset($this->_currentSort);
if (list($currentField,$currentDirection) = each($this->_currentSort)
and $currentField == $field) {
if ($currentDirection == 'ASC') {
$icon = $this->_options['sortIconASC'];
$cssClass = $this->_options['classASC'];
$direction = 'DESC';
} else {
$icon = $this->_options['sortIconDESC'];
$cssClass = $this->_options['classDESC'];
$direction = 'ASC';
}
} else {
$icon = '';
$direction = $this->_defaultDirections[$field];
}
$page = $this->_options['sortingResetsPaging'] ? 1 : $this->_page;
// Check if NUM is enabled
if ($this->_urlMapper) {
$url = $this->_buildMapperURL($field, $direction, $page);
} else {
// Build HTTP query
$extra = array('page' => $page);
$query = $this->_buildSortingHttpQuery($field, $direction, true, $extra);
// Build Link URL
$url = $this->_options['selfPath'] . '?' . $query;
}
// Build onclick attribute
$onclick =
$this->_buildOnMoveCall($page, array($field => $direction));
$onclick = $onclick ? "onclick=\"return $onclick\"" : '';
// Build HTML Link
$str = "<a href=\"$url\" $onclick>$label$icon</a>";
} else {
$str = $label;
}
// Print Content to HTML_Table
$this->_tableHeader->setHeaderContents($row, $col, $str);
// Set TH attributes
$attributes = isset($this->_options['columnAttributes'][$field])
? $this->_options['columnAttributes'][$field] : array();
if ($cssClass) {
$attributes['class'] = isset($attributes['class'])
? "{$attributes['class']} $cssClass" : $cssClass;
}
if ($attributes) {
$this->_tableHeader->setCellAttributes($row, $col, $attributes);
}
}
if (count($this->_options['headerAttributes']) > 0) {
$this->_tableHeader->setRowAttributes($row, $this->_options['headerAttributes'], false);
}
}
/**
* Build a body row
*
* @param int $index Row index (zero-based)
* @param array $data Record data.
* Structure: array(0 => <value0>, 1 => <value1>, ...)
* @return void
* @access protected
*/
function buildRow($index, $data)
{
$outputRow = $this->_bodyStartRow + $index;
foreach ($data as $col => $value) {
$field = $this->_columns[$col]['field'];
// Right-align the content if it is numeric
$attributes = ($this->_options['numberAlign'] and is_numeric($value))
? array('align' => 'right')
: array();
// merge auto-aligned and column attributes
if (isset($this->_options['columnAttributes'][$field])) {
$attributes = array_merge($attributes,
$this->_options['columnAttributes'][$field]);
}
// Set content in HTML_Table
$this->_tableBody->setCellContents($outputRow, $col, $value);
if ($attributes) {
$this->_tableBody->setCellAttributes($outputRow, $col, $attributes);
}
}
}
/**
* Build an empty row
*
* This method will only be called if the "fillWithEmptyRows" option is
* enabled.
*
* @param int $index Row index (zero-based)
* @return void
* @abstract
*/
function buildEmptyRow($index)
{
$outputRow = $this->_bodyStartRow + $index;
for ($col = 0; $col < $this->_columnsNum; $col++) {
$this->_tableBody->setCellAttributes($outputRow, $col, $this->_options['emptyRowAttributes']);
$this->_tableBody->setCellContents($outputRow, $col, ' ');
}
}
/**
* Default formatter for all cells
*
* @param string Cell value
* @return string Formatted cell value
* @access protected
*/
function defaultCellFormatter($value)
{
return $this->_options['convertEntities']
? htmlspecialchars($value, ENT_COMPAT, $this->_options['encoding'])
: $value;
}
/**
* Finish building the datagrid.
*
* @access protected
* @return void
*/
function finalize()
{
// Define alternating row attributes
if ($this->_options['evenRowAttributes']
or $this->_options['oddRowAttributes']) {
$this->_tableBody->altRowAttributes(
0,
$this->_options['evenRowAttributes'],
$this->_options['oddRowAttributes'],
true
);
}
}
/**
* Retrieve output from the container object
*
* @return mixed Output
* @access protected
*/
function flatten()
{
return $this->_table->toHTML();
}
/**
* Handles the building of the page list for the DataGrid in HTML.
*
* This method uses the HTML::Pager class
*
* Useful options (See Pager's documentation for more):
* mode: The mode of pager to use
* separator: The string to use to separate each page link
* prevImg: The string for the previous page link
* nextImg: The string for the forward page link
* delta: The number of pages to display before and
* after the current page
*
* @deprecated Use Structures_DataGrid_Renderer_Pager instead
* @access public
* @param array $options Array of HTML::Pager options
* @return string The HTML for the page links
* @see HTML::Pager
*/
function getPaging($options = array())
{
// This is a BC workaround for the old version of this method
if (is_string($options)) {
$argsNum = func_num_args();
$args = func_get_args();
$options = array();
for ($i = 0; $i < $argsNum; $i++) {
switch ($i) {
case 0: $options['mode'] = $args[$i]; break;
case 1: $options['separator'] = $args[$i]; break;
case 2: $options['prevImg'] = $args[$i]; break;
case 3: $options['nextImg'] = $args[$i]; break;
case 4: $options['delta'] = $args[$i]; break;
case 5: $options = array_merge($options, $args[$i]); break;
}
}
}
// Propagate the selfPath option. Do not override user params
if (!isset($options['path']) && !isset($options['filename'])) {
$options['path'] = dirname($this->_options['selfPath']);
$options['fileName'] = basename($this->_options['selfPath']);
$options['fixFileName'] = false;
}
// Load and get output from the Pager rendering driver
$driver =& Structures_DataGrid::loadDriver('Structures_DataGrid_Renderer_Pager');
$driver->setupAs($this, $options);
$driver->build(array(), 0, true);
return $driver->getOutput();
}
}
/* vim: set expandtab tabstop=4 shiftwidth=4: */
?>
|