Documentation

rex_list
in package
implements rex_url_provider_interface Uses rex_factory_trait

Klasse zum erstellen von Listen.

Table of Contents

Interfaces

rex_url_provider_interface
Generic interface for classes which provide urls.

Constants

DISABLE_PAGINATION  = \null

Properties

$sql  : rex_sql

Methods

addColumn()  : void
Methode, um eine Spalte einzufügen.
addFormAttribute()  : void
addLinkAttribute()  : void
addParam()  : void
addTableAttribute()  : void
addTableColumn()  : void
Fügt der zuletzte eingefügten TableColumnGroup eine weitere Spalte hinzu.
addTableColumnGroup()  : void
Methode um eine Colgroup einzufügen.
factory()  : static
formatValue()  : string
Formatiert einen übergebenen String anhand der rexFormatter Klasse.
get()  : string
Erstellt den Tabellen Quellcode.
getArrayValue()  : array<string|int, mixed>
getCaption()  : string
Gibt die Caption/den Titel der Tabelle zurück.
getColumnFormat()  : array{: string, : mixed, : array}|T
Gibt das Format für eine Spalte zurück.
getColumnLabel()  : string|null
Gibt das Label der Spalte zurück, falls gesetzt.
getColumnLayout()  : array{: string, : string}
Gibt das Layout einer Spalte zurück.
getColumnLayouts()  : array<string, array{: string, : string}>
Gibt die Layouts aller Spalten zurück.
getColumnLink()  : string
getColumnName()  : string|null
Gibt den Namen einer Spalte zurück.
getColumnNames()  : array<int, string>
Gibt alle Namen der Spalten als Array zurück.
getColumnOption()  : mixed|null
Gibt den Wert einer Option für eine Spalte zurück.
getColumnParams()  : array<string|int, mixed>
Gibt die Parameter für eine Spalte zurück.
getColumnPosition()  : int
Gibt die Position einer Spalte zurück.
getFooter()  : string
Gibt den Footer der Liste zurück.
getFormAttributes()  : array<string, string|int>
getHeader()  : string
Gibt den Header der Liste zurück.
getLinkAttributes()  : array<string, string|int>|null
getMessage()  : string
Gibt eine Status Nachricht zurück.
getName()  : string
Gibt den Namen es Formulars zurück.
getNoRowsMessage()  : string
getPager()  : rex_pager|null
Returns the pager for this list.
getParams()  : array<string, string|int>
getParsedUrl()  : string
Gibt eine Url zurück, die die Parameter $params enthält Dieser Url werden die Standard rexList Variablen zugefügt.
getRowAttributes()  : array<string, string|int>|callable(self): string
Methode, um die Zeilen-Attribute (<tr>) abzufragen.
getRows()  : int
Gibt die Anzahl der Zeilen zurück, welche vom ursprüngliche SQL Statement betroffen werden.
getSortColumn()  : string|null
Gibt zurück, nach welcher Spalte sortiert werden soll.
getSortType()  : string|null
Gibt zurück, in welcher Art und Weise sortiert werden soll (ASC/DESC).
getTableAttributes()  : array<string, string|int>
getTableColumnGroups()  : array<string|int, mixed>
getUrl()  : string
Returns a Url which contains the given parameters.
getValue()  : scalar|null
getWarning()  : string
Gibt eine Warnung zurück.
hasColumnOption()  : bool
Gibt zurück, ob für eine Spalte eine Option gesetzt wurde.
hasColumnParams()  : bool
Gibt zurück, ob Parameter für eine Spalte existieren.
init()  : void
isCustomFormat()  : bool
removeColumn()  : void
Entfernt eine Spalte aus der Anzeige.
replaceVariable()  : string
replaceVariables()  : string
Ersetzt alle Variablen im Format ###&lt;Spaltenname&gt;###.
setCaption()  : void
Setzt die Caption/den Titel der Tabelle Gibt den Namen es Formulars zurück.
setColumnFormat()  : void
Setzt ein Format für die Spalte.
setColumnLabel()  : void
Setzt ein Label für eine Spalte.
setColumnLayout()  : void
Methode, um das Layout einer Spalte zu setzen.
setColumnOption()  : void
Setzt eine Option für eine Spalte (z.b. Sortable,..).
setColumnParams()  : void
Verlinkt eine Spalte mit den übergebenen Parametern.
setColumnPosition()  : int
Verschiebt eine Spalte an eine andere Position in der Spaltenliste.
setColumnSortable()  : void
Markiert eine Spalte als sortierbar.
setNoRowsMessage()  : void
setRowAttributes()  : void
Methode, um der Zeile (<tr>) Attribute hinzuzufügen.
show()  : void
__construct()  : mixed
Erstellt ein rex_list Objekt.
_getAttributeString()  : string
formatRowAttributes()  : string
getColumnValue()  : string
getEnabledColumnNames()  : array<int, string>
getPagination()  : string
Gibt die Navigation der Liste zurück.
getRowsOnCurrentPage()  : int
loadBackendConfig()  : void
prepareQuery()  : string
Prepariert das SQL Statement vorm anzeigen der Liste.

Constants

DISABLE_PAGINATION

public mixed DISABLE_PAGINATION = \null

Properties

$sql

protected rex_sql $sql

Methods

addColumn()

Methode, um eine Spalte einzufügen.

public addColumn(string $columnHead, string $columnBody[, int $columnIndex = -1 ][, array<string|int, mixed> $columnLayout = null ]) : void
Parameters
$columnHead : string

Titel der Spalte

$columnBody : string

Text/Format der Spalte

$columnIndex : int = -1

Stelle, an der die neue Spalte erscheinen soll

$columnLayout : array<string|int, mixed> = null

Layout der Spalte

addFormAttribute()

public addFormAttribute(string $name, string|int $value) : void
Parameters
$name : string
$value : string|int

addLinkAttribute()

public addLinkAttribute(string $columnName, string $attrName, string|int $attrValue) : void
Parameters
$columnName : string
$attrName : string
$attrValue : string|int

addParam()

public addParam(string $name, string|int $value) : void
Parameters
$name : string
$value : string|int

addTableAttribute()

public addTableAttribute(string $name, string|int $value) : void
Parameters
$name : string
$value : string|int

addTableColumn()

Fügt der zuletzte eingefügten TableColumnGroup eine weitere Spalte hinzu.

public addTableColumn(int|"*" $width[, int $span = null ][, mixed $class = null ]) : void
Parameters
$width : int|"*"

Breite der Spalte

$span : int = null

Span der Spalte

$class : mixed = null

addTableColumnGroup()

Methode um eine Colgroup einzufügen.

public addTableColumnGroup(array<string|int, mixed> $columns[, int $columnGroupSpan = null ]) : void

Beispiel 1:

$list->addTableColumnGroup([40, '*', 240, 140]);

Beispiel 2:

$list->addTableColumnGroup([ ['width' => 40], ['width' => 140, 'span' => 2], ['width' => 240] ]);

Beispiel 3:

$list->addTableColumnGroup([ ['class' => 'classname-a'], ['class' => 'classname-b'], ['class' => 'classname-c'] ]);

Parameters
$columns : array<string|int, mixed>

Array von Spalten

$columnGroupSpan : int = null

Span der Columngroup

factory()

public static factory(string $query[, int|self::DISABLE_PAGINATION $rowsPerPage = 30 ][, string|null $listName = null ][, bool $debug = false ][, positive-int $db = 1 ][, array<string, "asc"|"desc"> $defaultSort = [] ]) : static
Parameters
$query : string
$rowsPerPage : int|self::DISABLE_PAGINATION = 30
$listName : string|null = null
$debug : bool = false
$db : positive-int = 1

DB connection ID

$defaultSort : array<string, "asc"|"desc"> = []
Return values
static

formatValue()

Formatiert einen übergebenen String anhand der rexFormatter Klasse.

public formatValue(string $value, array<string|int, mixed>|null $format, bool $escape[, string $field = null ]) : string
Parameters
$value : string

Zu formatierender String

$format : array<string|int, mixed>|null

mit den Formatierungsinformationen

$escape : bool

Flag, Ob escapen von $value erlaubt ist

$field : string = null
Return values
string

get()

Erstellt den Tabellen Quellcode.

public get() : string
Return values
string

getArrayValue()

public getArrayValue(mixed $column) : array<string|int, mixed>
Parameters
$column : mixed
Return values
array<string|int, mixed>

getCaption()

Gibt die Caption/den Titel der Tabelle zurück.

public getCaption() : string
Return values
string

getColumnFormat()

Gibt das Format für eine Spalte zurück.

public getColumnFormat(string $columnName[, T $default = null ]) : array{: string, : mixed, : array}|T
Parameters
$columnName : string

Name der Spalte

$default : T = null

Defaultrückgabewert, falls keine Formatierung gesetzt ist

Tags
template

T

Return values
array{: string, : mixed, : array}|T

getColumnLabel()

Gibt das Label der Spalte zurück, falls gesetzt.

public getColumnLabel(string $columnName[, T $default = null ]) : string|null

Falls nicht vorhanden und der Parameter $default auf null steht, wird der Spaltenname zurückgegeben

Parameters
$columnName : string

Name der Spalte

$default : T = null

Defaultrückgabewert, falls kein Label gesetzt ist

Tags
template

T as null|string

psalm-return

(T is null ? string : ?string)

Return values
string|null

getColumnLayout()

Gibt das Layout einer Spalte zurück.

public getColumnLayout(string $columnName) : array{: string, : string}
Parameters
$columnName : string

Name der Spalte

Return values
array{: string, : string}

getColumnLayouts()

Gibt die Layouts aller Spalten zurück.

public getColumnLayouts() : array<string, array{: string, : string}>
Return values
array<string, array{: string, : string}>
public getColumnLink(mixed $columnName, mixed $columnValue[, mixed $params = [] ]) : string
Parameters
$columnName : mixed
$columnValue : mixed
$params : mixed = []
Return values
string

getColumnName()

Gibt den Namen einer Spalte zurück.

public getColumnName(int $columnIndex[, mixed $default = null ]) : string|null
Parameters
$columnIndex : int

Nummer der Spalte

$default : mixed = null

Defaultrückgabewert, falls keine Spalte mit der angegebenen Nummer vorhanden ist

Return values
string|null

getColumnNames()

Gibt alle Namen der Spalten als Array zurück.

public getColumnNames() : array<int, string>
Return values
array<int, string>

getColumnOption()

Gibt den Wert einer Option für eine Spalte zurück.

public getColumnOption(string $columnName, string|int $option[, mixed $default = null ]) : mixed|null
Parameters
$columnName : string

Name der Spalte

$option : string|int

Name/Id der Option

$default : mixed = null

Defaultrückgabewert, falls die Option nicht gesetzt ist

Return values
mixed|null

getColumnParams()

Gibt die Parameter für eine Spalte zurück.

public getColumnParams(string $columnName) : array<string|int, mixed>
Parameters
$columnName : string

Name der Spalte

Return values
array<string|int, mixed>

getColumnPosition()

Gibt die Position einer Spalte zurück.

public getColumnPosition(string $columnName) : int
Parameters
$columnName : string

Name der Spalte

Tags
throws
InvalidArgumentException

$columnName kommt in $this->columnNames nicht vor

Return values
int

Index der Spalte

getFooter()

Gibt den Footer der Liste zurück.

public getFooter() : string
Return values
string

getFormAttributes()

public getFormAttributes() : array<string, string|int>
Return values
array<string, string|int>

getHeader()

Gibt den Header der Liste zurück.

public getHeader() : string
Return values
string

getLinkAttributes()

public getLinkAttributes(mixed $column[, mixed $default = null ]) : array<string, string|int>|null
Parameters
$column : mixed
$default : mixed = null
Return values
array<string, string|int>|null

getMessage()

Gibt eine Status Nachricht zurück.

public getMessage() : string
Return values
string

getName()

Gibt den Namen es Formulars zurück.

public getName() : string
Return values
string

getNoRowsMessage()

public getNoRowsMessage() : string
Return values
string

getParams()

public getParams() : array<string, string|int>
Return values
array<string, string|int>

getParsedUrl()

Gibt eine Url zurück, die die Parameter $params enthält Dieser Url werden die Standard rexList Variablen zugefügt.

public getParsedUrl([array<string|int, mixed> $params = [] ][, bool $escape = true ]) : string

Innerhalb dieser Url werden variablen ersetzt

Parameters
$params : array<string|int, mixed> = []
$escape : bool = true

Flag whether the argument separator "&" should be escaped (&)

Tags
see

#replaceVariable, #replaceVariables

Return values
string

getRowAttributes()

Methode, um die Zeilen-Attribute (<tr>) abzufragen.

public getRowAttributes() : array<string, string|int>|callable(self): string
Return values
array<string, string|int>|callable(self): string

Entweder ein array: [attributname => attribut, ...] oder eine Callback-Funktion

getRows()

Gibt die Anzahl der Zeilen zurück, welche vom ursprüngliche SQL Statement betroffen werden.

public getRows() : int
Return values
int

getSortColumn()

Gibt zurück, nach welcher Spalte sortiert werden soll.

public getSortColumn([string|null $default = null ]) : string|null
Parameters
$default : string|null = null
Return values
string|null

getSortType()

Gibt zurück, in welcher Art und Weise sortiert werden soll (ASC/DESC).

public getSortType(["asc"|"desc"|null $default = null ]) : string|null
Parameters
$default : "asc"|"desc"|null = null
Tags
psalm-taint-escape

html

psalm-taint-escape

sql

Return values
string|null

getTableAttributes()

public getTableAttributes() : array<string, string|int>
Return values
array<string, string|int>

getTableColumnGroups()

public getTableColumnGroups() : array<string|int, mixed>
Return values
array<string|int, mixed>

getUrl()

Returns a Url which contains the given parameters.

public getUrl([array<string|int, mixed> $params = [] ][, mixed $escape = true ]) : string
Parameters
$params : array<string|int, mixed> = []

A scalar array containing key value pairs for the parameter and its value

$escape : mixed = true

Flag whether the argument separator "&" should be escaped (&)

Return values
string

The generated Url

getValue()

public getValue(mixed $column) : scalar|null
Parameters
$column : mixed
Return values
scalar|null

getWarning()

Gibt eine Warnung zurück.

public getWarning() : string
Return values
string

hasColumnOption()

Gibt zurück, ob für eine Spalte eine Option gesetzt wurde.

public hasColumnOption(string $columnName, string|int $option) : bool
Parameters
$columnName : string

Name der Spalte

$option : string|int

Name/Id der Option

Return values
bool

hasColumnParams()

Gibt zurück, ob Parameter für eine Spalte existieren.

public hasColumnParams(string $columnName) : bool
Parameters
$columnName : string

Name der Spalte

Return values
bool

init()

public init() : void

isCustomFormat()

public isCustomFormat(mixed $format) : bool
Parameters
$format : mixed
Return values
bool

removeColumn()

Entfernt eine Spalte aus der Anzeige.

public removeColumn(string $columnName) : void
Parameters
$columnName : string

Name der Spalte

replaceVariable()

public replaceVariable(mixed $string, mixed $varname) : string
Parameters
$string : mixed
$varname : mixed
Return values
string

replaceVariables()

Ersetzt alle Variablen im Format ###&lt;Spaltenname&gt;###.

public replaceVariables(string $value) : string
Parameters
$value : string

Zu durchsuchender String

Tags
psalm-taint-specialize
Return values
string

setCaption()

Setzt die Caption/den Titel der Tabelle Gibt den Namen es Formulars zurück.

public setCaption(string $caption) : void
Parameters
$caption : string

Caption/Titel der Tabelle

setColumnFormat()

Setzt ein Format für die Spalte.

public setColumnFormat(string $columnName, string $formatType[, mixed $format = '' ][, array<string|int, mixed> $params = [] ]) : void
Parameters
$columnName : string

Name der Spalte

$formatType : string

Formatierungstyp

$format : mixed = ''

Zu verwendentes Format

$params : array<string|int, mixed> = []

Custom params für callback func bei format_type 'custom'

setColumnLabel()

Setzt ein Label für eine Spalte.

public setColumnLabel(string $columnName, string $label) : void
Parameters
$columnName : string

Name der Spalte

$label : string

Label für die Spalte

setColumnLayout()

Methode, um das Layout einer Spalte zu setzen.

public setColumnLayout(string $columnHead, array<string|int, mixed> $columnLayout) : void
Parameters
$columnHead : string

Titel der Spalte

$columnLayout : array<string|int, mixed>

Layout der Spalte

setColumnOption()

Setzt eine Option für eine Spalte (z.b. Sortable,..).

public setColumnOption(string $columnName, string|int $option, mixed $value) : void
Parameters
$columnName : string

Name der Spalte

$option : string|int

Name/Id der Option

$value : mixed

Wert der Option

setColumnParams()

Verlinkt eine Spalte mit den übergebenen Parametern.

public setColumnParams(string $columnName[, array<string|int, mixed> $params = [] ]) : void
Parameters
$columnName : string

Name der Spalte

$params : array<string|int, mixed> = []

Array von Parametern

setColumnPosition()

Verschiebt eine Spalte an eine andere Position in der Spaltenliste.

public setColumnPosition(string $columnName, int|string $columnIndex) : int
Parameters
$columnName : string

Name der Spalte

$columnIndex : int|string

Einfügen vor der angegebenen Spalte (Spalten-Index analog zu addColumn oder Spaltenname)

Return values
int

Spaltennummer der neuen Position

setColumnSortable()

Markiert eine Spalte als sortierbar.

public setColumnSortable(string $columnName[, string $direction = 'asc' ]) : void
Parameters
$columnName : string

Name der Spalte

$direction : string = 'asc'

Startsortierrichtung der Spalte [ASC|DESC]

setNoRowsMessage()

public setNoRowsMessage(string $message) : void
Parameters
$message : string

setRowAttributes()

Methode, um der Zeile (<tr>) Attribute hinzuzufügen.

public setRowAttributes(array<string, string|int>|callable(self): string $attr) : void
Parameters
$attr : array<string, string|int>|callable(self): string

Entweder ein array: [attributname => attribut, ...] oder eine Callback-Funktion

show()

public show() : void

__construct()

Erstellt ein rex_list Objekt.

protected __construct(string $query[, int|self::DISABLE_PAGINATION $rowsPerPage = 30 ][, string|null $listName = null ][, bool $debug = false ][, positive-int $db = 1 ][, array<string, "asc"|"desc"> $defaultSort = [] ]) : mixed
Parameters
$query : string

SELECT Statement

$rowsPerPage : int|self::DISABLE_PAGINATION = 30
$listName : string|null = null

Name der Liste

$debug : bool = false
$db : positive-int = 1
$defaultSort : array<string, "asc"|"desc"> = []

_getAttributeString()

protected _getAttributeString(mixed $array) : string
Parameters
$array : mixed
Return values
string

formatRowAttributes()

protected formatRowAttributes() : string
Return values
string

getColumnValue()

protected getColumnValue(string $columnName, array{: string, : mixed, : array}|null $columnFormat) : string
Parameters
$columnName : string
$columnFormat : array{: string, : mixed, : array}|null
Return values
string

getEnabledColumnNames()

protected getEnabledColumnNames() : array<int, string>
Return values
array<int, string>

getPagination()

Gibt die Navigation der Liste zurück.

protected getPagination() : string
Return values
string

getRowsOnCurrentPage()

protected getRowsOnCurrentPage() : int
Return values
int

loadBackendConfig()

protected loadBackendConfig() : void

prepareQuery()

Prepariert das SQL Statement vorm anzeigen der Liste.

protected prepareQuery(string $query[, array<string, "asc"|"desc"> $defaultSort = [] ]) : string
Parameters
$query : string

SQL Statement

$defaultSort : array<string, "asc"|"desc"> = []
Return values
string

        
On this page

Search results