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

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

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

Свойство Тип Описание
$aliases stores the alias definitions
$db initialized via _getDb()
$locs stores custom key localizations

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

Метод Описание
__construct ( ) Constructor
_a2ua ( string $name, string | array $array ) : array prepare an array to be passed through buildURLparams()
_addPrePostFixes ( string | array $type, string $val, string $pre = '', string $post = '' ) : string Add pre and postfixs to the given value
_aliases ( ) : array Load defined type aliases
_cleanData ( string $value, string | array $type ) : string Makes sure the given data fits with the given type
_column ( string $col ) Split a column name into its parts
_formatData ( array $column, string $value, Doku_Renderer_xhtml $R ) : string Return XHTML formated data, depending on column type
_getDB ( ) : helper_plugin_sqlite | false load the sqlite helper
_getTagUrlparam ( array $column, string $tag ) : array Get url parameters, remove all filters for given column and add filter for desired tag
_get_current_param ( boolean $returnURLparams = true ) : array get current URL parameters
_get_filters ( ) : array Get filters given in the request via GET or POST
_parse_filter ( $filterline ) : array | boolean Parse a filter line into an array
_replacePlaceholdersInSQL ( &$data ) Replace placeholders in sql
_resolveData ( string $value, string $colname ) : string Resolve a value according to its column settings
ensureAbsoluteId ( $id )
makeTranslationReplacement ( string $data ) : string Replace translation related placeholders in given string
ready ( ) : boolean Simple function to check if the database is ready to use

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

Метод Описание
determineLang ( ) : mixed Return language code

Приватные методы

Метод Описание
loadLocalizedLabels ( )
replacePlaceholders ( string $value ) : string Perform replacements on the output values

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

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

Loads custom translations
public __construct ( )

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

prepare an array to be passed through buildURLparams()
public _a2ua ( string $name, string | array $array ) : array
$name string keyname
$array string | array value or key-value pairs
Результат array

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

$type may be an column array with pre and postfixes
public _addPrePostFixes ( string | array $type, string $val, string $pre = '', string $post = '' ) : string
$type string | array
$val string
$pre string
$post string
Результат string

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

Load defined type aliases
public _aliases ( ) : array
Результат array

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

Makes sure the given data fits with the given type
public _cleanData ( string $value, string | array $type ) : string
$value string
$type string | array
Результат string

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

Split a column name into its parts
public _column ( string $col )
$col string column name

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

Return XHTML formated data, depending on column type
public _formatData ( array $column, string $value, Doku_Renderer_xhtml $R ) : string
$column array
$value string
$R Doku_Renderer_xhtml
Результат string

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

load the sqlite helper
public _getDB ( ) : helper_plugin_sqlite | false
Результат helper_plugin_sqlite | false plugin or false if failed

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

Get url parameters, remove all filters for given column and add filter for desired tag
public _getTagUrlparam ( array $column, string $tag ) : array
$column array
$tag string
Результат array of url parameters

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

get current URL parameters
public _get_current_param ( boolean $returnURLparams = true ) : array
$returnURLparams boolean
Результат array with dataflt, datasrt and dataofs parameters

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

Get filters given in the request via GET or POST
public _get_filters ( ) : array
Результат array

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

Parse a filter line into an array
public _parse_filter ( $filterline ) : array | boolean
$filterline
Результат array | boolean - array on success, false on error

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

Replace placeholders in sql
public _replacePlaceholdersInSQL ( &$data )

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

This function is registered as a SQL function named DATARESOLVE
public _resolveData ( string $value, string $colname ) : string
$value string
$colname string
Результат string

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

Return language code
protected determineLang ( ) : mixed
Результат mixed

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

public ensureAbsoluteId ( $id )

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

Replace translation related placeholders in given string
public makeTranslationReplacement ( string $data ) : string
$data string
Результат string

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

Simple function to check if the database is ready to use
public ready ( ) : boolean
Результат boolean

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

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

stores the alias definitions
protected $aliases

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

initialized via _getDb()
protected $db

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

stores custom key localizations
protected $locs