PHP Класс Contao\DataContainer

Provide methods to handle data container arrays.
Наследование: extends Backend
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$blnUploadable boolean True if one of the form fields is uploadable
$intId integer Current ID
$noReload boolean Reload the page after the form has been submitted
$objActiveRecord Model | FilesModel Active record
$onsubmit array Form attribute "onsubmit"
$procedure array WHERE clause of the database query
$root array IDs of all root records
$strField string Name of the current field
$strInputName string Name attribute of the current input field
$strPalette string Name of the current palette
$strTable string Name of the current table
$values array Values for the WHERE clause of the database query
$varValue mixed Value of the current field

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

Метод Описание
__get ( string $strKey ) : mixed Return an object property
__set ( string $strKey, mixed $varValue ) Set an object property
getPalette ( ) : string Return the name of the current palette
help ( string $strClass = '' ) : string Return the field explanation as HTML string

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

Метод Описание
combiner ( array $names ) : array Generate possible palette names from an array by taking the first value and either adding or not adding the following values
generateButtons ( array $arrRow, string $strTable, array $arrRootIds = [], boolean $blnCircularReference = false, array $arrChildRecordIds = null, string $strPrevious = null, string $strNext = null ) : string Compile buttons from the table configuration array and return them as HTML
generateGlobalButtons ( ) : string Compile global buttons from the table configuration array and return them as HTML
row ( string $strPalette = null ) : string Render a row of a box and return it as HTML string
save ( mixed $varValue ) Save the current value
switchToEdit ( integer $id ) : string Return a query string that switches into edit mode

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

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

Return an object property
public __get ( string $strKey ) : mixed
$strKey string
Результат mixed

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

Set an object property
public __set ( string $strKey, mixed $varValue )
$strKey string
$varValue mixed

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

Generate possible palette names from an array by taking the first value and either adding or not adding the following values
protected combiner ( array $names ) : array
$names array
Результат array

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

Compile buttons from the table configuration array and return them as HTML
protected generateButtons ( array $arrRow, string $strTable, array $arrRootIds = [], boolean $blnCircularReference = false, array $arrChildRecordIds = null, string $strPrevious = null, string $strNext = null ) : string
$arrRow array
$strTable string
$arrRootIds array
$blnCircularReference boolean
$arrChildRecordIds array
$strPrevious string
$strNext string
Результат string

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

Compile global buttons from the table configuration array and return them as HTML
protected generateGlobalButtons ( ) : string
Результат string

getPalette() абстрактный публичный Метод

Return the name of the current palette
abstract public getPalette ( ) : string
Результат string

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

Return the field explanation as HTML string
public help ( string $strClass = '' ) : string
$strClass string
Результат string

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

Render a row of a box and return it as HTML string
protected row ( string $strPalette = null ) : string
$strPalette string
Результат string

save() абстрактный защищенный Метод

Save the current value
abstract protected save ( mixed $varValue )
$varValue mixed

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

Return a query string that switches into edit mode
protected switchToEdit ( integer $id ) : string
$id integer
Результат string

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

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

True if one of the form fields is uploadable
protected bool $blnUploadable
Результат boolean

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

Current ID
protected int $intId
Результат integer

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

Reload the page after the form has been submitted
protected bool $noReload
Результат boolean

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

Active record
protected Model,contao|FilesModel,contao $objActiveRecord
Результат Model | FilesModel

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

Form attribute "onsubmit"
protected array $onsubmit
Результат array

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

WHERE clause of the database query
protected array $procedure
Результат array

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

IDs of all root records
protected array $root
Результат array

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

Name of the current field
protected string $strField
Результат string

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

Name attribute of the current input field
protected string $strInputName
Результат string

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

Name of the current palette
protected string $strPalette
Результат string

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

Name of the current table
protected string $strTable
Результат string

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

Values for the WHERE clause of the database query
protected array $values
Результат array

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

Value of the current field
protected mixed $varValue
Результат mixed