Methods

setFactoryClass()

setFactoryClass(string  $subclass) : mixed

Sets the class for the factory.

Parameters

string $subclass

Classname

Throws

\InvalidArgumentException

Returns

mixed —

getFactoryClass()

getFactoryClass() : string

Returns the class for the factory.

Returns

string —

hasFactoryClass()

hasFactoryClass() : bool

Returns if the class has a custom factory class.

Returns

bool —

factory()

factory(string  $query, int  $rowsPerPage = 30, string|null  $listName = null, bool  $debug = false, int  $db = 1) : static

Parameters

string $query
int $rowsPerPage
string|null $listName
bool $debug
int $db

DB connection ID

Returns

static —

init()

init() : mixed

Returns

mixed —

getName()

getName() : string

Gibt den Namen es Formulars zurück.

Returns

string —

getMessage()

getMessage() : string

Gibt eine Status Nachricht zurück.

Returns

string —

getWarning()

getWarning() : string

Gibt eine Warnung zurück.

Returns

string —

setCaption()

setCaption(string  $caption) : mixed

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

Parameters

string $caption

Caption/Titel der Tabelle

Returns

mixed —

getCaption()

getCaption() : string

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

Returns

string —

setNoRowsMessage()

setNoRowsMessage(string  $message) : mixed

Parameters

string $message

Returns

mixed —

getNoRowsMessage()

getNoRowsMessage() : mixed

Returns

mixed —

addParam()

addParam(string  $name, string|int  $value) : mixed

Parameters

string $name
string|int $value

Returns

mixed —

getParams()

getParams() : array<string,string|int>

Returns

array

addTableAttribute()

addTableAttribute(string  $name, string|int  $value) : mixed

Parameters

string $name
string|int $value

Returns

mixed —

getTableAttributes()

getTableAttributes() : mixed

Returns

mixed —

addFormAttribute()

addFormAttribute(string  $name, string|int  $value) : mixed

Parameters

string $name
string|int $value

Returns

mixed —

getFormAttributes()

getFormAttributes() : array<string,string|int>

Returns

array

addLinkAttribute()

addLinkAttribute(mixed  $columnName, mixed  $attrName, mixed  $attrValue) : mixed

Parameters

mixed $columnName
mixed $attrName
mixed $attrValue

Returns

mixed —

getLinkAttributes()

getLinkAttributes(mixed  $column, mixed  $default = null) : mixed

Parameters

mixed $column
mixed $default

Returns

mixed —

setRowAttributes()

setRowAttributes(mixed  $attr) : void

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

Parameters

mixed $attr

getRowAttributes()

getRowAttributes() : mixed

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

Returns

mixed —

addColumn()

addColumn(string  $columnHead, string  $columnBody, int  $columnIndex = -1, array  $columnLayout = null) : mixed

Methode, um eine Spalte einzufügen.

Parameters

string $columnHead

Titel der Spalte

string $columnBody

Text/Format der Spalte

int $columnIndex

Stelle, an der die neue Spalte erscheinen soll

array $columnLayout

Layout der Spalte

Returns

mixed —

removeColumn()

removeColumn(string  $columnName) : mixed

Entfernt eine Spalte aus der Anzeige.

Parameters

string $columnName

Name der Spalte

Returns

mixed —

setColumnLayout()

setColumnLayout(string  $columnHead, array  $columnLayout) : mixed

Methode, um das Layout einer Spalte zu setzen.

Parameters

string $columnHead

Titel der Spalte

array $columnLayout

Layout der Spalte

Returns

mixed —

getColumnLayout()

getColumnLayout(string  $columnName) : array

Gibt das Layout einer Spalte zurück.

Parameters

string $columnName

Name der Spalte

Returns

array —

getColumnLayouts()

getColumnLayouts() : mixed

Gibt die Layouts aller Spalten zurück.

Returns

mixed —

getColumnName()

getColumnName(int  $columnIndex, mixed  $default = null) : string|null

Gibt den Namen einer Spalte zurück.

Parameters

int $columnIndex

Nummer der Spalte

mixed $default

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

Returns

string|null —

getColumnNames()

getColumnNames() : array

Gibt alle Namen der Spalten als Array zurück.

Returns

array —

setColumnLabel()

setColumnLabel(string  $columnName, string  $label) : mixed

Setzt ein Label für eine Spalte.

Parameters

string $columnName

Name der Spalte

string $label

Label für die Spalte

Returns

mixed —

getColumnLabel()

getColumnLabel(string  $columnName, mixed  $default = null) : string|null

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

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

Parameters

string $columnName

Name der Spalte

mixed $default

Defaultrückgabewert, falls kein Label gesetzt ist

Returns

string|null —

setColumnFormat()

setColumnFormat(string  $columnName, string  $formatType, mixed  $format = '', array  $params = []) : mixed

Setzt ein Format für die Spalte.

Parameters

string $columnName

Name der Spalte

string $formatType

Formatierungstyp

mixed $format

Zu verwendentes Format

array $params

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

Returns

mixed —

getColumnFormat()

getColumnFormat(string  $columnName, mixed  $default = null) : array|null

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

Parameters

string $columnName

Name der Spalte

mixed $default

Defaultrückgabewert, falls keine Formatierung gesetzt ist

Returns

array|null —

setColumnSortable()

setColumnSortable(string  $columnName, string  $direction = 'asc') : mixed

Markiert eine Spalte als sortierbar.

Parameters

string $columnName

Name der Spalte

string $direction

Startsortierrichtung der Spalte [ASC|DESC]

Returns

mixed —

setColumnOption()

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

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

Parameters

string $columnName

Name der Spalte

string|int $option

Name/Id der Option

mixed $value

Wert der Option

Returns

mixed —

getColumnOption()

getColumnOption(string  $columnName, string|int  $option, mixed  $default = null) : mixed|null

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

Parameters

string $columnName

Name der Spalte

string|int $option

Name/Id der Option

mixed $default

Defaultrückgabewert, falls die Option nicht gesetzt ist

Returns

mixed|null —

hasColumnOption()

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

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

Parameters

string $columnName

Name der Spalte

string|int $option

Name/Id der Option

Returns

bool —

setColumnParams()

setColumnParams(string  $columnName, array  $params = []) : mixed

Verlinkt eine Spalte mit den übergebenen Parametern.

Parameters

string $columnName

Name der Spalte

array $params

Array von Parametern

Returns

mixed —

getColumnParams()

getColumnParams(string  $columnName) : array

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

Parameters

string $columnName

Name der Spalte

Returns

array —

hasColumnParams()

hasColumnParams(string  $columnName) : bool

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

Parameters

string $columnName

Name der Spalte

Returns

bool —

addTableColumnGroup()

addTableColumnGroup(array  $columns, int  $columnGroupSpan = null) : mixed

Methode um eine Colgroup einzufügen.

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

array $columns

Array von Spalten

int $columnGroupSpan

Span der Columngroup

Returns

mixed —

getTableColumnGroups()

getTableColumnGroups() : array

Returns

array —

addTableColumn()

addTableColumn(mixed  $width, int  $span = null, mixed  $class = null) : mixed

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

Parameters

mixed $width
int $span

Span der Spalte

mixed $class

Returns

mixed —

getUrl()

getUrl(array  $params = [], mixed  $escape = true) : string

Returns a Url which contains the given parameters.

Parameters

array $params

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

mixed $escape

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

Returns

string —

The generated Url

getParsedUrl()

getParsedUrl(array  $params = [], bool  $escape = true) : string

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

Innerhalb dieser Url werden variablen ersetzt

Parameters

array $params
bool $escape

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

Returns

string —

getRows()

getRows() : int

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

Returns

int —

getPager()

getPager() : \rex_pager

Returns the pager for this list.

Returns

\rex_pager —

getSortColumn()

getSortColumn(string|null  $default = null) : string|null

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

Parameters

string|null $default

Returns

string|null —

getSortType()

getSortType(mixed  $default = null) : string|null

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

Parameters

mixed $default

Returns

string|null —

getFooter()

getFooter() : string

Gibt den Footer der Liste zurück.

Returns

string —

getHeader()

getHeader() : string

Gibt den Header der Liste zurück.

Returns

string —

replaceVariable()

replaceVariable(mixed  $string, mixed  $varname) : string

Parameters

mixed $string
mixed $varname

Returns

string —

replaceVariables()

replaceVariables(string  $value) : string

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

Parameters

string $value

Zu durchsuchender String

Returns

string —

isCustomFormat()

isCustomFormat(mixed  $format) : bool

Parameters

mixed $format

Returns

bool —

formatValue()

formatValue(string  $value, null|array  $format, bool  $escape, string  $field = null) : string

Formatiert einen übergebenen String anhand der rexFormatter Klasse.

Parameters

string $value

Zu formatierender String

null|array $format

mit den Formatierungsinformationen

bool $escape

Flag, Ob escapen von $value erlaubt ist

string $field

Returns

string —

getColumnLink()

getColumnLink(mixed  $columnName, mixed  $columnValue, mixed  $params = []) : string

Parameters

mixed $columnName
mixed $columnValue
mixed $params

Returns

string —

getValue()

getValue(mixed  $column) : mixed

Parameters

mixed $column

Returns

mixed —

getArrayValue()

getArrayValue(mixed  $column) : mixed

Parameters

mixed $column

Returns

mixed —

get()

get() : string

Erstellt den Tabellen Quellcode.

Returns

string —

show()

show() : mixed

Returns

mixed —

callFactoryClass()

callFactoryClass(string  $method, array  $arguments) : mixed

Calls the factory class with the given method and arguments.

Parameters

string $method

Method name

array $arguments

Array of arguments

Returns

mixed —

Result of the callback

__construct()

__construct(string  $query, int  $rowsPerPage = 30, string|null  $listName = null, bool  $debug = false, int  $db = 1) : mixed

Erstellt ein rex_list Objekt.

Parameters

string $query

SELECT Statement

int $rowsPerPage

Anzahl der Elemente pro Zeile

string|null $listName

Name der Liste

bool $debug
int $db

Returns

mixed —

loadBackendConfig()

loadBackendConfig() : mixed

Returns

mixed —

prepareQuery()

prepareQuery(string  $query) : string

Prepariert das SQL Statement vorm anzeigen der Liste.

Parameters

string $query

SQL Statement

Returns

string —

getPagination()

getPagination() : string

Gibt die Navigation der Liste zurück.

Returns

string —

_getAttributeString()

_getAttributeString(mixed  $array) : string

Parameters

mixed $array

Returns

string —