ColumnItem extends ColumnItem
Class created by Core/Base/PluginManager
Table of Contents
$description | Additional text that explains the field to the user | string |
---|---|---|
$display | State and alignment of the display configuration (left|right|center|none) | string |
$level | Selected security level. | int |
$numcolumns | int | |
$order | int | |
$title | string | |
$titleurl | string | |
$widget | Field display object configuration | BaseWidget |
$class | string | |
$i18n | Translator | |
$id | Identifies the object with a defined name in the view | string |
$name | Name defined in the view as key | string |
$token | string | |
$uniqueId | int | |
__construct() | mixed | |
edit() | string | |
htmlWidth() | Returns CSS percentage width | string |
hidden() | bool | |
processFormData() | mixed | |
tableCell() | string | |
tableHeader() | string | |
loadWidget() | mixed | |
getLevel() | int | |
getToken() | string | |
setLevel() | mixed | |
setToken() | mixed | |
colorToClass() | string | |
getColorFromOption() | Calculate color from option configuration | string |
applyOperatorFromOption() | bool | |
combineClasses() | string | |
css() | Returns equivalent css class to $class. To extend in plugins. | string |
getUniqueId() | int |
Properties
$description
Additional text that explains the field to the user
public
string
$description
$display
State and alignment of the display configuration (left|right|center|none)
public
string
$display
$level
Selected security level.
private
static int
$level
= ""
$numcolumns
public
int
$numcolumns
$order
public
int
$order
$title
public
string
$title
$titleurl
public
string
$titleurl
$widget
Field display object configuration
public
BaseWidget
$widget
$class
public
string
$class
$i18n
protected
static Translator
$i18n
$id
Identifies the object with a defined name in the view
public
string
$id
$name
Name defined in the view as key
public
string
$name
$token
private
static string
$token
= ''
$uniqueId
protected
static int
$uniqueId
= -1
Methods
__construct()
public
__construct(
$data :
array
)
: mixed
Parameters
- $data : array
Return values
mixededit()
public
edit(
$model :
object
[, $onlyField :
bool
= false ]
)
: string
Parameters
- $model : object
- $onlyField : bool = false
Return values
stringhtmlWidth()
Returns CSS percentage width
public
htmlWidth(
)
: string
Return values
stringhidden()
public
hidden(
)
: bool
Return values
boolprocessFormData()
public
processFormData(
&$model :
object
, $request :
Request
)
: mixed
Parameters
- $model : object
- $request : Request
Return values
mixedtableCell()
public
tableCell(
$model :
object
)
: string
Parameters
- $model : object
Return values
stringtableHeader()
public
tableHeader(
)
: string
Return values
stringloadWidget()
protected
loadWidget(
$children :
array
)
: mixed
Parameters
- $children : array
Return values
mixedgetLevel()
public
static getLevel(
)
: int
Return values
intgetToken()
public
static getToken(
)
: string
Return values
stringsetLevel()
public
static setLevel(
$new :
int
)
: mixed
Parameters
- $new : int
Return values
mixedsetToken()
public
static setToken(
$token :
string
)
: mixed
Parameters
- $token : string
Return values
mixedcolorToClass()
protected
colorToClass(
$color :
string
, $prefix :
string
)
: string
Parameters
- $color : string
- $prefix : string
Return values
stringgetColorFromOption()
Calculate color from option configuration
public
getColorFromOption(
$option :
string[]
, $value :
mixed
, $prefix :
string
)
: string
Parameters
- $option : string[]
- $value : mixed
- $prefix : string
Return values
stringapplyOperatorFromOption()
protected
applyOperatorFromOption(
$option :
string[]
, $value :
mixed
)
: bool
Parameters
- $option : string[]
- $value : mixed
Return values
boolcombineClasses()
protected
combineClasses(
...$classes :
array
)
: string
Parameters
- $classes : array
Return values
stringcss()
Returns equivalent css class to $class. To extend in plugins.
protected
css(
$class :
string
)
: string
Parameters
- $class : string
Return values
stringgetUniqueId()
protected
getUniqueId(
)
: int