FacturaScripts

ColumnItem extends VisualItem
in package

Description of ColumnItem

Tags
author

Jose Antonio Cuello Principal [email protected]

author

Carlos García Gómez [email protected]

Table of Contents

$class  : string
$description  : string
Additional text that explains the field to the user
$display  : string
State and alignment of the display configuration (left|right|center|none)
$id  : string
Identifies the object with a defined name in the view
$level  : int
Indicates the security level of the column
$name  : string
Name defined in the view as key
$numcolumns  : int
$order  : int
$title  : string
$titleurl  : string
$widget  : BaseWidget
Field display object configuration
$i18n  : Translator
$uniqueId  : int
$token  : string
__construct()  : mixed
edit()  : string
getColorFromOption()  : string
Calculate color from option configuration
getLevel()  : int
getToken()  : string
hidden()  : bool
htmlWidth()  : string
Returns CSS percentage width
processFormData()  : mixed
setLevel()  : mixed
setToken()  : mixed
tableCell()  : string
tableHeader()  : string
applyOperatorFromOption()  : bool
colorToClass()  : string
combineClasses()  : string
css()  : string
Returns equivalent css class to $class. To extend in plugins.
getUniqueId()  : int
loadWidget()  : void

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

$id

Identifies the object with a defined name in the view

public string $id

$level

Indicates the security level of the column

public int $level

$name

Name defined in the view as key

public string $name

Methods

__construct()

public __construct(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Return values
mixed —

edit()

public edit(object $model[, bool $onlyField = false ]) : string
Parameters
$model : object
$onlyField : bool = false
Return values
string —

getColorFromOption()

Calculate color from option configuration

public getColorFromOption(array<string|int, string> $option, mixed $value, string $prefix) : string
Parameters
$option : array<string|int, string>
$value : mixed
$prefix : string
Return values
string —

getLevel()

public static getLevel() : int
Return values
int —

getToken()

public static getToken() : string
Return values
string —

hidden()

public hidden() : bool
Return values
bool —

htmlWidth()

Returns CSS percentage width

public htmlWidth() : string
Return values
string —

processFormData()

public processFormData(object &$model, Request $request) : mixed
Parameters
$model : object
$request : Request
Return values
mixed —

setLevel()

public static setLevel(int $new) : mixed
Parameters
$new : int
Return values
mixed —

setToken()

public static setToken(string $token) : mixed
Parameters
$token : string
Return values
mixed —

tableCell()

public tableCell(object $model) : string
Parameters
$model : object
Return values
string —

applyOperatorFromOption()

protected applyOperatorFromOption(array<string|int, string> $option, mixed $value) : bool
Parameters
$option : array<string|int, string>
$value : mixed
Return values
bool —

colorToClass()

protected colorToClass(string $color, string $prefix) : string
Parameters
$color : string
$prefix : string
Return values
string —

combineClasses()

protected combineClasses(array<string|int, mixed> ...$classes) : string
Parameters
$classes : array<string|int, mixed>
Return values
string —

css()

Returns equivalent css class to $class. To extend in plugins.

protected css(string $class) : string
Parameters
$class : string
Return values
string —

getUniqueId()

protected getUniqueId() : int
Return values
int —

loadWidget()

protected loadWidget(array<string|int, mixed> $children) : void
Parameters
$children : array<string|int, mixed>
Return values
void —

Search results