Documentation

LabelField extends TextField
in package

Form header control

Table of Contents

$class  : string
CSS class
$disabled  : bool
Is field disabled
$hasLabel  : bool
Does field have got label or not
$namePrefix  : string
Field name's prefix
$title  : string
Title value
$toggler  : string
toggler selector
$toggleValue  : string
Toggle value
$value  : string
Field value
$visible  : bool
Visible field or not
$batch  : bool
Is field batched
$custom  : bool
Is field custom
$name  : string
Name of the field
$required  : bool
Is field required
$type  : string
Field type
__construct()  : mixed
Constructor
fillAllRow()  : bool
Does control fills all row
getName()  : string
Method returns name
getNamePrefix()  : string
Method returns name preffix for field
getTitle()  : string
Method returns title
getType()  : string
Getting field type
hasLabel()  : bool
Method returns field's label existence
html()  : string
Generating input feld
isBatch()  : bool
Method returns is batch
isCustom()  : bool
Method returns is custom
isRequired()  : bool
Method returns if required
isVisible()  : bool
Method returns field's visibility
initBatch()  : void
Method fetches field batch property from the description
initClass()  : void
Method fetches field CSS class from the description
initCustom()  : void
Method fetches field custom property from the description
initDisabled()  : void
Method fetches field disabled property from the description
initHasLabel()  : void
Method fetches label display
initName()  : void
Method fetches field name from the description
initNamePrefix()  : void
Method fetches name prefix
initRequired()  : void
Method fetches field required property from the description
initTitle()  : void
Method fetches field title
inittoggler()  : void
Method fetches field toggler property from the description
initToggleValue()  : void
Method fetches field toggle value property from the description
initType()  : void
Method fetches field type
initVisible()  : void
Method fetches field's visibility

Properties

$hasLabel

Does field have got label or not

protected bool $hasLabel = false

Methods

__construct()

Constructor

public __construct(array<string|int, mixed> $fieldDescription[, string $value = '' ]) : mixed
Parameters
$fieldDescription : array<string|int, mixed>

Field description

$value : string = ''

Field value

Return values
mixed

getName()

Method returns name

public getName() : string
Return values
string

name

getNamePrefix()

Method returns name preffix for field

public getNamePrefix() : string
Return values
string

name preffix if defined, empty string otherwise

getTitle()

Method returns title

public getTitle() : string
Return values
string

Title

getType()

Getting field type

public getType() : string
Return values
string

Field type

hasLabel()

Method returns field's label existence

public hasLabel() : bool
Return values
bool

Has label

html()

Generating input feld

public html() : string
Return values
string

HTML representation of the input field

isBatch()

Method returns is batch

public isBatch() : bool
Return values
bool

is batch

isCustom()

Method returns is custom

public isCustom() : bool
Return values
bool

is custom

isRequired()

Method returns if required

public isRequired() : bool
Return values
bool

required

isVisible()

Method returns field's visibility

public isVisible() : bool
Return values
bool

Is field visible

initBatch()

Method fetches field batch property from the description

private initBatch(array<string|int, mixed> $fieldDescription) : void
Parameters
$fieldDescription : array<string|int, mixed>

field description

Return values
void

initClass()

Method fetches field CSS class from the description

private initClass(array<string|int, mixed> $fieldDescription) : void
Parameters
$fieldDescription : array<string|int, mixed>

field description

Return values
void

initCustom()

Method fetches field custom property from the description

private initCustom(array<string|int, mixed> $fieldDescription) : void
Parameters
$fieldDescription : array<string|int, mixed>

field description

Return values
void

initDisabled()

Method fetches field disabled property from the description

private initDisabled(array<string|int, mixed> $fieldDescription) : void
Parameters
$fieldDescription : array<string|int, mixed>

field description

Return values
void

initHasLabel()

Method fetches label display

private initHasLabel(array<string|int, mixed> $fieldDescription) : void
Parameters
$fieldDescription : array<string|int, mixed>

field description

Return values
void

initName()

Method fetches field name from the description

private initName(array<string|int, mixed> $fieldDescription) : void
Parameters
$fieldDescription : array<string|int, mixed>

field description

Return values
void

initNamePrefix()

Method fetches name prefix

private initNamePrefix(array<string|int, mixed> $fieldDescription) : void
Parameters
$fieldDescription : array<string|int, mixed>

field description

Return values
void

initRequired()

Method fetches field required property from the description

private initRequired(array<string|int, mixed> $fieldDescription) : void
Parameters
$fieldDescription : array<string|int, mixed>

field description

Return values
void

initTitle()

Method fetches field title

private initTitle(array<string|int, mixed> $fieldDescription) : void
Parameters
$fieldDescription : array<string|int, mixed>

field description

Return values
void

inittoggler()

Method fetches field toggler property from the description

private inittoggler(array<string|int, mixed> $fieldDescription) : void
Parameters
$fieldDescription : array<string|int, mixed>

field description

Return values
void

initToggleValue()

Method fetches field toggle value property from the description

private initToggleValue(array<string|int, mixed> $fieldDescription) : void
Parameters
$fieldDescription : array<string|int, mixed>

field description

Return values
void

initType()

Method fetches field type

private initType(array<string|int, mixed> $fieldDescription) : void
Parameters
$fieldDescription : array<string|int, mixed>

field description

Return values
void

initVisible()

Method fetches field's visibility

private initVisible(array<string|int, mixed> $fieldDescription) : void
Parameters
$fieldDescription : array<string|int, mixed>

field description

Return values
void

Search results