Tsugi

Table
in package

Our class to generate pageable tables.

This handles all the details for generating pageable, sortable tables that from a particular database query.

This is a pretty complex class and for now the best way to understand it is to look at its use in various places throughout the code.

This also interoperates with the CrudForm class in those cases where a table needs links to a detail page for a row as seen in admin/key/index.php

Tags
todo

This is still emergent and as new use cases are encountered it will likely evolve.

Table of Contents

Properties

$DEFAULT_PAGE_LENGTH  : mixed

Methods

doForm()  : mixed
doUrl()  : mixed
makeUrl()  : mixed
matchColumns()  : mixed
pagedAuto()  : mixed
pagedHeader()  : mixed
pagedQuery()  : mixed
pagedTable()  : mixed

Properties

$DEFAULT_PAGE_LENGTH

public static mixed $DEFAULT_PAGE_LENGTH = 20

Methods

doForm()

public static doForm(mixed $values[, mixed $override = array() ]) : mixed
Parameters
$values : mixed
$override : mixed = array()

doUrl()

public static doUrl(mixed $values[, mixed $override = array() ]) : mixed
Parameters
$values : mixed
$override : mixed = array()

makeUrl()

public static makeUrl(mixed $url, mixed $values[, mixed $override = array() ]) : mixed
Parameters
$url : mixed
$values : mixed
$override : mixed = array()

matchColumns()

public static matchColumns(mixed $colname, mixed $columns) : mixed
Parameters
$colname : mixed
$columns : mixed

pagedAuto()

public static pagedAuto(mixed $sql, mixed $query_parms, mixed $searchfields[, mixed $orderfields = false ][, mixed $view = false ][, mixed $params = false ][, mixed $buttons = false ][, mixed $after_html = '' ]) : mixed
Parameters
$sql : mixed
$query_parms : mixed
$searchfields : mixed
$orderfields : mixed = false
$view : mixed = false
$params : mixed = false
$buttons : mixed = false
$after_html : mixed = ''

pagedHeader()

public static pagedHeader(mixed $rows[, mixed $searchfields = array() ][, mixed $orderfields = false ][, mixed $view = false ][, mixed $params = false ][, mixed $extra_buttons = false ][, mixed $after_html = '' ]) : mixed
Parameters
$rows : mixed
$searchfields : mixed = array()
$orderfields : mixed = false
$view : mixed = false
$params : mixed = false
$extra_buttons : mixed = false
$after_html : mixed = ''

pagedQuery()

public static pagedQuery(mixed $sql, mixed &$queryvalues[, mixed $searchfields = array() ][, mixed $orderfields = false ][, mixed $params = false ]) : mixed
Parameters
$sql : mixed
$queryvalues : mixed
$searchfields : mixed = array()
$orderfields : mixed = false
$params : mixed = false

pagedTable()

public static pagedTable(mixed $rows[, mixed $searchfields = array() ][, mixed $orderfields = false ][, mixed $view = false ][, mixed $params = false ][, mixed $extra_buttons = false ][, mixed $after_html = '' ]) : mixed
Parameters
$rows : mixed
$searchfields : mixed = array()
$orderfields : mixed = false
$view : mixed = false
$params : mixed = false
$extra_buttons : mixed = false
$after_html : mixed = ''

        
On this page

Search results