PHP Class syntax_plugin_data_table, dokuwiki-plugin-data

Inheritance: extends DokuWiki_Syntax_Plugin

Afficher le fichier Open project: splitbrain/dokuwiki-plugin-data Class Usage Examples

Méthodes publiques

Свойство	Type	Description
$dthlp		will hold the data helper plugin
$sums

Protected Properties

Свойство	Type	Description
$after_item
$after_val
$before_item
$before_val

Méthodes publiques

Méthode	Description
__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

Méthodes protégées

Méthode	Description
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.

Method Details

__construct() public méthode

Constructor. Load helper plugin

public __construct ( )

_buildSQL() public méthode

Builds the SQL query from the given data

public _buildSQL ( &$data ) : boolean \| string
Résultat	boolean \| string	SQL query or false

afterVal() protected méthode

After value in table cell

protected afterVal ( array &$data, integer $colno ) : string
$data	array
$colno	integer
Résultat	string

beforeVal() protected méthode

Before value in table cell

protected beforeVal ( array &$data, integer $colno ) : string
$data	array	instructions by handler
$colno	integer	column number
Résultat	string

connectTo() public méthode

Connect pattern to lexer

public connectTo ( $mode )

getPType() public méthode

What about paragraphs?

public getPType ( )

getSort() public méthode

Where to sort in?

public getSort ( )

getType() public méthode

What kind of syntax are we?

public getType ( )

handle() public méthode

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
Résultat	boolean \| array	Return an array with all data you want to use in render, false don't add an instruction

hasRequestFilter() public méthode

Check whether a sort or filter request parameters are available

public hasRequestFilter ( ) : boolean
Résultat	boolean

nullList() public méthode

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() protected méthode

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
Résultat	array

postList() public méthode

Create table footer

public postList ( array $data, integer $rowcnt ) : string
$data	array	instruction by handler()
$rowcnt	integer	number of rows
Résultat	string	html of table footer

preList() public méthode

Create table header

public preList ( array $clist, array $data ) : string
$clist	array	keys of the columns
$data	array	instruction by handler
Résultat	string	html of table header

render() public méthode

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()
Résultat	boolean	rendered correctly? (however, returned value is not used at the moment)

updateSQLwithQuery() public méthode

Handle request paramaters, rebuild sql when needed

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

Property Details

$after_item protected_oe property

protected $after_item

$after_val protected_oe property

protected $after_val

$before_item protected_oe property

protected $before_item

$before_val protected_oe property

protected $before_val

$dthlp public_oe property

will hold the data helper plugin

public $dthlp

$sums public_oe property

public $sums