FacturaScripts

GroupItem extends VisualItem
in package

Description of GroupItem

Tags
author

Jose Antonio Cuello Principal [email protected]

author

Carlos García Gómez [email protected]

Table of Contents

$class  : string
$columns  : array<string|int, ColumnItem>
Define the columns that the group includes
$icon  : string
Icon used as the value or accompanying the group title
$id  : string
Identifies the object with a defined name in the view
$name  : string
Name defined in the view as key
$numcolumns  : int
$order  : int
$title  : string
$valign  : string
$description  : string
Description
$i18n  : Translator
$uniqueId  : int
$level  : int
Selected security level.
$token  : string
__construct()  : mixed
edit()  : string
getColorFromOption()  : string
Calculate color from option configuration
getLevel()  : int
getToken()  : string
modal()  : string
processFormData()  : mixed
setLevel()  : mixed
setToken()  : mixed
sortColumns()  : int
Sorts the columns
applyOperatorFromOption()  : bool
colorToClass()  : string
combineClasses()  : string
css()  : string
Returns equivalent css class to $class. To extend in plugins.
getUniqueId()  : int
legend()  : string
loadColumns()  : mixed
valign()  : string

Properties

$columns

Define the columns that the group includes

public array<string|int, ColumnItem> $columns = []

$icon

Icon used as the value or accompanying the group title

public string $icon

$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

$description

Description

protected string $description

$level

Selected security level.

private static int $level = 0

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 $forceReadOnly = false ][, bool $onlyField = false ]) : string
Parameters
$model : object
$forceReadOnly : bool = false
$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 —

modal()

public modal(object $model, string $viewName) : string
Parameters
$model : object
$viewName : 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 —

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 —

legend()

protected legend() : string
Return values
string —

loadColumns()

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

valign()

protected valign() : string
Return values
string —

Search results