PHP Класс syntax_plugin_data_table, dokuwiki-plugin-data

Наследование: extends DokuWiki_Syntax_Plugin

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$dthlp		will hold the data helper plugin
$sums

Защищенные свойства (Protected)

Свойство	Тип	Описание
$after_item
$after_val
$before_item
$before_val

Открытые методы

Метод	Описание
__construct ( )	Constructor. Load helper plugin
_buildSQL ( &$data ) : boolean \| string	Builds the SQL query from the given data
connectTo ( $mode )	Connect pattern to lexer
getPType ( )	What about paragraphs?
getSort ( )	Where to sort in?
getType ( )	What kind of syntax are we?
handle ( string $match, integer $state, integer $pos, Doku_Handler $handler ) : boolean \| array	Handle the match - parse the data
hasRequestFilter ( ) : boolean	Check whether a sort or filter request parameters are available
nullList ( array $data, array $clist, Doku_Renderer $R )	Create an empty table
postList ( array $data, integer $rowcnt ) : string	Create table footer
preList ( array $clist, array $data ) : string	Create table header
render ( string $format, Doku_Renderer $R, array $data ) : boolean	Handles the actual output creation.
updateSQLwithQuery ( array &$data )	Handle request paramaters, rebuild sql when needed

Защищенные методы

Метод	Описание
afterVal ( array &$data, integer $colno ) : string	After value in table cell
beforeVal ( array &$data, integer $colno ) : string	Before value in table cell
parseValues ( string $line ) : array	Split values at the commas, - Wrap with quotes to escape comma, quotes escaped by two quotes - Within quotes spaces are stored.

Описание методов

__construct() публичный Метод

Constructor. Load helper plugin

public __construct ( )

_buildSQL() публичный Метод

Builds the SQL query from the given data

public _buildSQL ( &$data ) : boolean \| string
Результат	boolean \| string	SQL query or false

afterVal() защищенный Метод

After value in table cell

protected afterVal ( array &$data, integer $colno ) : string
$data	array
$colno	integer
Результат	string

beforeVal() защищенный Метод

Before value in table cell

protected beforeVal ( array &$data, integer $colno ) : string
$data	array	instructions by handler
$colno	integer	column number
Результат	string

connectTo() публичный Метод

Connect pattern to lexer

public connectTo ( $mode )

getPType() публичный Метод

What about paragraphs?

public getPType ( )

getSort() публичный Метод

Where to sort in?

public getSort ( )

getType() публичный Метод

What kind of syntax are we?

public getType ( )

handle() публичный Метод

This parsing is shared between the multiple different output/control syntaxes

public handle ( string $match, integer $state, integer $pos, Doku_Handler $handler ) : boolean \| array
$match	string	The text matched by the patterns
$state	integer	The lexer state for the match
$pos	integer	The character position of the matched text
$handler	Doku_Handler	The Doku_Handler object
Результат	boolean \| array	Return an array with all data you want to use in render, false don't add an instruction

hasRequestFilter() публичный Метод

Check whether a sort or filter request parameters are available

public hasRequestFilter ( ) : boolean
Результат	boolean

nullList() публичный Метод

Create an empty table

public nullList ( array $data, array $clist, Doku_Renderer $R )
$data	array	instruction by handler()
$clist	array	keys of the columns
$R	Doku_Renderer

parseValues() защищенный Метод

Split values at the commas, - Wrap with quotes to escape comma, quotes escaped by two quotes - Within quotes spaces are stored.

protected parseValues ( string $line ) : array
$line	string
Результат	array

postList() публичный Метод

Create table footer

public postList ( array $data, integer $rowcnt ) : string
$data	array	instruction by handler()
$rowcnt	integer	number of rows
Результат	string	html of table footer

preList() публичный Метод

Create table header

public preList ( array $clist, array $data ) : string
$clist	array	keys of the columns
$data	array	instruction by handler
Результат	string	html of table header

render() публичный Метод

Handles the actual output creation.

public render ( string $format, Doku_Renderer $R, array $data ) : boolean
$format	string	output format being rendered
$R	Doku_Renderer	the current renderer object
$data	array	data created by handler()
Результат	boolean	rendered correctly? (however, returned value is not used at the moment)

updateSQLwithQuery() публичный Метод

Handle request paramaters, rebuild sql when needed

public updateSQLwithQuery ( array &$data )
$data	array	instruction by handler()

Описание свойств

$after_item защищенное свойство

protected $after_item

$after_val защищенное свойство

protected $after_val

$before_item защищенное свойство

protected $before_item

$before_val защищенное свойство

protected $before_val

$dthlp публичное свойство

will hold the data helper plugin

public $dthlp

$sums публичное свойство

public $sums