SettingsGroup extends InputGroup
in package

Table of Contents

$description  : mixed
$fields  : array<string|int, InputField>
$label  : mixed
$name  : mixed
$page  : mixed
__construct()  : mixed
addField()  : mixed
addFields()  : mixed
getAttsFromRequest()  : mixed
getFieldByName()  : InputField|null
getFields()  : array<string|int, InputField>
getIndexByName()  : int
getLabel()  : mixed
getName()  : mixed
getPage()  : mixed
hasField()  : bool
insertField()  : mixed
register()  : mixed
removeField()  : bool
render()  : mixed
save()  : mixed
setName()  : mixed

Properties

$description

protected mixed $description

$fields

protected array<string|int, InputField> $fields = array()

$label

protected mixed $label

$name

protected mixed $name

$page

protected mixed $page

Methods

__construct()

public __construct(string $name, string $label, string $page[, string $description = '' ]) : mixed
Parameters
$name : string
$label : string

Optional.

$page : string
$description : string = ''

Optional.

Tags
note

that name of group must

Return values
mixed —

addField()

public addField(InputField $field) : mixed
Parameters
$field : InputField
Return values
mixed —

addFields()

public addFields(array<string|int, InputField> $fields) : mixed
Parameters
$fields : array<string|int, InputField>
Return values
mixed —

getAttsFromRequest()

public getAttsFromRequest([mixed $request = null ][, mixed $allowReadonly = true ]) : mixed
Parameters
$request : mixed = null
$allowReadonly : mixed = true
Return values
mixed —

getFieldByName()

public getFieldByName(string $name) : InputField|null
Parameters
$name : string
Return values
InputField|null —

Searched field or null if nothing found.

getFields()

public getFields() : array<string|int, InputField>
Return values
array<string|int, InputField> —

getIndexByName()

public getIndexByName(string $name) : int
Parameters
$name : string
Return values
int —

Field index or -1 if nothing found.

getLabel()

public getLabel() : mixed
Return values
mixed —

getName()

public getName() : mixed
Return values
mixed —

getPage()

public getPage() : mixed
Return values
mixed —

hasField()

public hasField(string $name) : bool
Parameters
$name : string
Tags
since
4.2.4
Return values
bool —

insertField()

public insertField(InputField $field, int $index) : mixed
Parameters
$field : InputField
$index : int
Return values
mixed —

register()

public register() : mixed
Return values
mixed —

removeField()

public removeField(int|string $key) : bool
Parameters
$key : int|string

Field index or name.

Return values
bool —

true if removed, false - otherwise

render()

public render() : mixed
Return values
mixed —

save()

public save() : mixed
Return values
mixed —

setName()

public setName(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed —

Search results