PHP Class rex_list, redaxo

Mostra file Open project: redaxo/redaxo Class Usage Examples

Public Methods

Method Description
addColumn ( string $columnHead, string $columnBody, integer $columnIndex, array $columnLayout = null ) Methode, um eine Spalte einzufügen.
addFormAttribute ( $attrName, $attrValue )
addLinkAttribute ( $columnName, $attrName, $attrValue )
addParam ( $name, $value )
addTableAttribute ( $attrName, $attrValue )
addTableColumn ( integer $width, integer $span = null, $class = null ) Fügt der zuletzte eingefügten TableColumnGroup eine weitere Spalte hinzu.
addTableColumnGroup ( array $columns, integer $columnGroupSpan = null ) Methode um eine Colgroup einzufügen.
factory ( string $query, integer $rowsPerPage = 30, null $listName = null, boolean $debug = false ) : static
formatValue ( string $value, array $format, boolean $escape, string $field = null ) : string Formatiert einen übergebenen String anhand der rexFormatter Klasse.
get ( ) : string Erstellt den Tabellen Quellcode.
getArrayValue ( $colname )
getCaption ( ) : string Gibt die Caption/den Titel der Tabelle zurück.
getColumnFormat ( string $columnName, mixed $default = null ) : string | null Gibt das Format für eine Spalte zurück.
getColumnLabel ( string $columnName, mixed $default = null ) : string | null Gibt das Label der Spalte zurück, falls gesetzt.
getColumnLayout ( string $columnName ) : array Gibt das Layout einer Spalte zurück.
getColumnLayouts ( ) Gibt die Layouts aller Spalten zurück.
getColumnLink ( $columnName, $columnValue, $params = [] )
getColumnName ( integer $columnIndex, mixed $default = null ) : string | null Gibt den Namen einer Spalte zurück.
getColumnNames ( ) : array Gibt alle Namen der Spalten als Array zurück.
getColumnOption ( string $columnName, string $option, mixed $default = null ) : mixed | null Gibt den Wert einer Option für eine Spalte zurück.
getColumnParams ( string $columnName ) : array Gibt die Parameter für eine Spalte zurück.
getFooter ( ) : string Gibt den Footer der Liste zurück.
getFormAttributes ( )
getHeader ( ) : string Gibt den Header der Liste zurück.
getLinkAttributes ( $column, $default = null )
getMessage ( ) : string Gibt eine Status Nachricht zurück.
getName ( ) : string Gibt den Namen es Formulars zurück.
getNoRowsMessage ( )
getPager ( ) : rex_pager Returns the pager for this list.
getParams ( )
getParsedUrl ( array $params = [], boolean $escape = true ) : string Gibt eine Url zurück, die die Parameter $params enthält Dieser Url werden die Standard rexList Variablen zugefügt.
getRows ( ) : integer Gibt die Anzahl der Zeilen zurück, welche vom ursprüngliche SQL Statement betroffen werden.
getSortColumn ( mixed $default = null ) : string Gibt zurück, nach welcher Spalte sortiert werden soll.
getSortType ( mixed $default = null ) : string Gibt zurück, in welcher Art und Weise sortiert werden soll (ASC/DESC).
getTableAttributes ( )
getTableColumnGroups ( ) : array
getUrl ( array $params = [], $escape = true )
getValue ( $colname )
getWarning ( ) : string Gibt eine Warnung zurück.
hasColumnOption ( string $columnName, string $option ) : boolean Gibt zurück, ob für eine Spalte eine Option gesetzt wurde.
hasColumnParams ( string $columnName ) : boolean Gibt zurück, ob Parameter für eine Spalte existieren.
init ( )
isCustomFormat ( $format )
removeColumn ( string $columnName ) Entfernt eine Spalte aus der Anzeige.
replaceVariable ( $string, $varname ) ---------------------- Generate Output
replaceVariables ( string $value ) : string Ersetzt alle Variablen im Format ###<Spaltenname>###.
setCaption ( string $caption ) Setzt die Caption/den Titel der Tabelle Gibt den Namen es Formulars zurück.
setColumnFormat ( string $columnName, string $format_type, mixed $format = '', array $params = [] ) Setzt ein Format für die Spalte.
setColumnLabel ( string $columnName, string $label ) Setzt ein Label für eine Spalte.
setColumnLayout ( string $columnHead, array $columnLayout ) Methode, um das Layout einer Spalte zu setzen.
setColumnOption ( string $columnName, string $option, mixed $value ) Setzt eine Option für eine Spalte (z.b. Sortable,.
setColumnParams ( string $columnName, array $params = [] ) Verlinkt eine Spalte mit den übergebenen Parametern.
setColumnSortable ( string $columnName, string $direction = 'asc' ) Markiert eine Spalte als sortierbar.
setNoRowsMessage ( $msg )
show ( )

Protected Methods

Method Description
__construct ( string $query, integer $rowsPerPage = 30, string $listName = null, boolean $debug = false ) Erstellt ein rex_list Objekt.
_getAttributeString ( $array )
getPagination ( ) : string Gibt die Navigation der Liste zurück.
loadBackendConfig ( )
prepareQuery ( string $query ) : string Prepariert das SQL Statement vorm anzeigen der Liste.

Method Details

__construct() protected method

Erstellt ein rex_list Objekt.
protected __construct ( string $query, integer $rowsPerPage = 30, string $listName = null, boolean $debug = false )
$query string SELECT Statement
$rowsPerPage integer Anzahl der Elemente pro Zeile
$listName string Name der Liste
$debug boolean

_getAttributeString() protected method

protected _getAttributeString ( $array )

addColumn() public method

Methode, um eine Spalte einzufügen.
public addColumn ( string $columnHead, string $columnBody, integer $columnIndex, array $columnLayout = null )
$columnHead string Titel der Spalte
$columnBody string Text/Format der Spalte
$columnIndex integer Stelle, an der die neue Spalte erscheinen soll
$columnLayout array Layout der Spalte

addFormAttribute() public method

public addFormAttribute ( $attrName, $attrValue )

addLinkAttribute() public method

public addLinkAttribute ( $columnName, $attrName, $attrValue )

addParam() public method

public addParam ( $name, $value )

addTableAttribute() public method

public addTableAttribute ( $attrName, $attrValue )

addTableColumn() public method

Fügt der zuletzte eingefügten TableColumnGroup eine weitere Spalte hinzu.
public addTableColumn ( integer $width, integer $span = null, $class = null )
$width integer Breite der Spalte
$span integer Span der Spalte

addTableColumnGroup() public method

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'] ]);
public addTableColumnGroup ( array $columns, integer $columnGroupSpan = null )
$columns array Array von Spalten
$columnGroupSpan integer Span der Columngroup

factory() public static method

public static factory ( string $query, integer $rowsPerPage = 30, null $listName = null, boolean $debug = false ) : static
$query string
$rowsPerPage integer
$listName null
$debug boolean
return static

formatValue() public method

Formatiert einen übergebenen String anhand der rexFormatter Klasse.
public formatValue ( string $value, array $format, boolean $escape, string $field = null ) : string
$value string Zu formatierender String
$format array mit den Formatierungsinformationen
$escape boolean Flag, Ob escapen von $value erlaubt ist
$field string
return string

get() public method

Erstellt den Tabellen Quellcode.
public get ( ) : string
return string

getArrayValue() public method

public getArrayValue ( $colname )

getCaption() public method

Gibt die Caption/den Titel der Tabelle zurück.
public getCaption ( ) : string
return string

getColumnFormat() public method

Gibt das Format für eine Spalte zurück.
public getColumnFormat ( string $columnName, mixed $default = null ) : string | null
$columnName string Name der Spalte
$default mixed Defaultrückgabewert, falls keine Formatierung gesetzt ist
return string | null

getColumnLabel() public method

Falls nicht vorhanden und der Parameter $default auf null steht, wird der Spaltenname zurückgegeben
public getColumnLabel ( string $columnName, mixed $default = null ) : string | null
$columnName string Name der Spalte
$default mixed Defaultrückgabewert, falls kein Label gesetzt ist
return string | null

getColumnLayout() public method

Gibt das Layout einer Spalte zurück.
public getColumnLayout ( string $columnName ) : array
$columnName string Name der Spalte
return array

getColumnLayouts() public method

Gibt die Layouts aller Spalten zurück.
public getColumnLayouts ( )

getColumnName() public method

Gibt den Namen einer Spalte zurück.
public getColumnName ( integer $columnIndex, mixed $default = null ) : string | null
$columnIndex integer Nummer der Spalte
$default mixed Defaultrückgabewert, falls keine Spalte mit der angegebenen Nummer vorhanden ist
return string | null

getColumnNames() public method

Gibt alle Namen der Spalten als Array zurück.
public getColumnNames ( ) : array
return array

getColumnOption() public method

Gibt den Wert einer Option für eine Spalte zurück.
public getColumnOption ( string $columnName, string $option, mixed $default = null ) : mixed | null
$columnName string Name der Spalte
$option string Name/Id der Option
$default mixed Defaultrückgabewert, falls die Option nicht gesetzt ist
return mixed | null

getColumnParams() public method

Gibt die Parameter für eine Spalte zurück.
public getColumnParams ( string $columnName ) : array
$columnName string Name der Spalte
return array

getFooter() public method

Gibt den Footer der Liste zurück.
public getFooter ( ) : string
return string

getFormAttributes() public method

public getFormAttributes ( )

getHeader() public method

Gibt den Header der Liste zurück.
public getHeader ( ) : string
return string

getLinkAttributes() public method

public getLinkAttributes ( $column, $default = null )

getMessage() public method

Gibt eine Status Nachricht zurück.
public getMessage ( ) : string
return string

getName() public method

Gibt den Namen es Formulars zurück.
public getName ( ) : string
return string

getNoRowsMessage() public method

public getNoRowsMessage ( )

getPager() public method

Returns the pager for this list.
public getPager ( ) : rex_pager
return rex_pager

getPagination() protected method

Gibt die Navigation der Liste zurück.
protected getPagination ( ) : string
return string

getParams() public method

public getParams ( )

getParsedUrl() public method

Innerhalb dieser Url werden variablen ersetzt
public getParsedUrl ( array $params = [], boolean $escape = true ) : string
$params array
$escape boolean Flag whether the argument separator "&" should be escaped (&)
return string

getRows() public method

Gibt die Anzahl der Zeilen zurück, welche vom ursprüngliche SQL Statement betroffen werden.
public getRows ( ) : integer
return integer

getSortColumn() public method

Gibt zurück, nach welcher Spalte sortiert werden soll.
public getSortColumn ( mixed $default = null ) : string
$default mixed
return string

getSortType() public method

Gibt zurück, in welcher Art und Weise sortiert werden soll (ASC/DESC).
public getSortType ( mixed $default = null ) : string
$default mixed
return string

getTableAttributes() public method

public getTableAttributes ( )

getTableColumnGroups() public method

public getTableColumnGroups ( ) : array
return array

getUrl() public method

public getUrl ( array $params = [], $escape = true )
$params array

getValue() public method

public getValue ( $colname )

getWarning() public method

Gibt eine Warnung zurück.
public getWarning ( ) : string
return string

hasColumnOption() public method

Gibt zurück, ob für eine Spalte eine Option gesetzt wurde.
public hasColumnOption ( string $columnName, string $option ) : boolean
$columnName string Name der Spalte
$option string Name/Id der Option
return boolean

hasColumnParams() public method

Gibt zurück, ob Parameter für eine Spalte existieren.
public hasColumnParams ( string $columnName ) : boolean
$columnName string Name der Spalte
return boolean

init() public method

public init ( )

isCustomFormat() public method

public isCustomFormat ( $format )

loadBackendConfig() protected method

protected loadBackendConfig ( )

prepareQuery() protected method

Prepariert das SQL Statement vorm anzeigen der Liste.
protected prepareQuery ( string $query ) : string
$query string SQL Statement
return string

removeColumn() public method

Entfernt eine Spalte aus der Anzeige.
public removeColumn ( string $columnName )
$columnName string Name der Spalte

replaceVariable() public method

---------------------- Generate Output
public replaceVariable ( $string, $varname )

replaceVariables() public method

Ersetzt alle Variablen im Format ###<Spaltenname>###.
public replaceVariables ( string $value ) : string
$value string Zu durchsuchender String
return string

setCaption() public method

Setzt die Caption/den Titel der Tabelle Gibt den Namen es Formulars zurück.
public setCaption ( string $caption )
$caption string Caption/Titel der Tabelle

setColumnFormat() public method

Setzt ein Format für die Spalte.
public setColumnFormat ( string $columnName, string $format_type, mixed $format = '', array $params = [] )
$columnName string Name der Spalte
$format_type string Formatierungstyp
$format mixed Zu verwendentes Format
$params array Custom params für callback func bei format_type 'custom'

setColumnLabel() public method

Setzt ein Label für eine Spalte.
public setColumnLabel ( string $columnName, string $label )
$columnName string Name der Spalte
$label string Label für die Spalte

setColumnLayout() public method

Methode, um das Layout einer Spalte zu setzen.
public setColumnLayout ( string $columnHead, array $columnLayout )
$columnHead string Titel der Spalte
$columnLayout array Layout der Spalte

setColumnOption() public method

.).
public setColumnOption ( string $columnName, string $option, mixed $value )
$columnName string Name der Spalte
$option string Name/Id der Option
$value mixed Wert der Option

setColumnParams() public method

Verlinkt eine Spalte mit den übergebenen Parametern.
public setColumnParams ( string $columnName, array $params = [] )
$columnName string Name der Spalte
$params array Array von Parametern

setColumnSortable() public method

Markiert eine Spalte als sortierbar.
public setColumnSortable ( string $columnName, string $direction = 'asc' )
$columnName string Name der Spalte
$direction string Startsortierrichtung der Spalte [ASC|DESC]

setNoRowsMessage() public method

public setNoRowsMessage ( $msg )

show() public method

public show ( )