Class rex_list

Klasse zum erstellen von Listen.

rex_list implements rex_url_provider_interface uses rex_factory_trait
Package: redaxo\core
Located at redaxo/src/core/lib/list.php

Methods summary

protected
# __construct( string $query, integer $rowsPerPage = 30, string $listName = null, boolean $debug = false, mixed $db = 1 )

Erstellt ein rex_list Objekt.

public static static
# factory( string $query, integer $rowsPerPage = 30, null $listName = null, boolean $debug = false, integer $db = 1 )
public
# init( )
public string
# getName( )

Gibt den Namen es Formulars zurück.

public string
# getMessage( )

Gibt eine Status Nachricht zurück.

public string
# getWarning( )

Gibt eine Warnung zurück.

public
# setCaption( string $caption )

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

public string
# getCaption( )

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

public
# setNoRowsMessage( mixed $msg )
public
public
# addParam( mixed $name, mixed $value )
public
protected
public
# addTableAttribute( mixed $attrName, mixed $attrValue )
public
public
# addFormAttribute( mixed $attrName, mixed $attrValue )
public
public
# addLinkAttribute( mixed $columnName, mixed $attrName, mixed $attrValue )
public
# getLinkAttributes( mixed $column, mixed $default = null )
public
# addColumn( string $columnHead, string $columnBody, integer $columnIndex = -1, array $columnLayout = null )

Methode, um eine Spalte einzufügen.

public
# removeColumn( string $columnName )

Entfernt eine Spalte aus der Anzeige.

public
# setColumnLayout( string $columnHead, array $columnLayout )

Methode, um das Layout einer Spalte zu setzen.

public array
# getColumnLayout( string $columnName )

Gibt das Layout einer Spalte zurück.

public
# getColumnLayouts( )

Gibt die Layouts aller Spalten zurück.

public string|null
# getColumnName( integer $columnIndex, mixed $default = null )

Gibt den Namen einer Spalte zurück.

public array
# getColumnNames( )

Gibt alle Namen der Spalten als Array zurück.

public
# setColumnLabel( string $columnName, string $label )

Setzt ein Label für eine Spalte.

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

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

public
# setColumnFormat( string $columnName, string $format_type, mixed $format = '', array $params = [] )

Setzt ein Format für die Spalte.

public string|null
# getColumnFormat( string $columnName, mixed $default = null )

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

public
# setColumnSortable( string $columnName, string $direction = 'asc' )

Markiert eine Spalte als sortierbar.

public
# setColumnOption( string $columnName, string $option, mixed $value )

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

public mixed|null
# getColumnOption( string $columnName, string $option, mixed $default = null )

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

public boolean
# hasColumnOption( string $columnName, string $option )

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

public
# setColumnParams( string $columnName, array $params = [] )

Verlinkt eine Spalte mit den übergebenen Parametern.

public array
# getColumnParams( string $columnName )

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

public boolean
# hasColumnParams( string $columnName )

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

public
# addTableColumnGroup( array $columns, integer $columnGroupSpan = null )

Methode um eine Colgroup einzufügen.

public array
# getTableColumnGroups( )
public
# addTableColumn( integer $width, integer $span = null, mixed $class = null )

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

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

Returns a Url which contains the given parameters.

public string
# getParsedUrl( array $params = [], boolean $escape = true )

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

protected string
# prepareQuery( string $query )

Prepariert das SQL Statement vorm anzeigen der Liste.

public integer
# getRows( )

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

public rex_pager
# getPager( )

Returns the pager for this list.

public string
# getSortColumn( mixed $default = null )

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

public string
# getSortType( mixed $default = null )

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

protected string
# getPagination( )

Gibt die Navigation der Liste zurück.

public string
# getFooter( )

Gibt den Footer der Liste zurück.

public string
# getHeader( )

Gibt den Header der Liste zurück.

public
# replaceVariable( mixed $string, mixed $varname )
public string
# replaceVariables( string $value )

Ersetzt alle Variablen im Format ###<Spaltenname>###.

public
# isCustomFormat( mixed $format )
public string
# formatValue( string $value, array $format, boolean $escape, string $field = null )

Formatiert einen übergebenen String anhand der rexFormatter Klasse.

protected
# _getAttributeString( mixed $array )
public
# getValue( mixed $colname )
public
# getArrayValue( mixed $colname )
public string
# get( )

Erstellt den Tabellen Quellcode.

public
# show( )

Methods used from rex_factory_trait

callFactoryClass(), getFactoryClass(), hasFactoryClass(), setFactoryClass()