1. class
  2. Windwalker
  3. Form
  4. Field
  5. AbstractField

AbstractField

class AbstractField (View source)

The AbstractField class.

Methods

__construct(string $name = null, string $label = null, array $attributes = array(), string $filter = null, string $validator = null)

Constructor.

string
renderInput()

getInput

mixed
buildInput(array $attrs)

buildInput

array
prepare(array $attrs)

prepareRenderInput

array
prepareAttributes()

prepareAttributes

string
renderLabel()

getLabel

string
renderView()

renderView

string
render()

render

mixed
getLabel()

getLabel

string
getId()

getId

ValidateResult
validate()

validate

mixed
checkRequired()

checkRequired

mixed
checkRule()

checkRule

AbstractField
filter()

filter

void
prepareStore()

prepareStore

string
getName(bool $withGroup = false)

Method to get property Name

AbstractField
setName(null $name)

Method to set property name

string
getFieldName(bool $refresh = false)

Method to get property FieldName

AbstractField
setFieldName(null $fieldName)

Method to set property fieldName

null
getGroup()

Method to get property Group

AbstractField
setGroup(null $group)

Method to set property group

null
getFieldset()

Method to get property Fieldset

AbstractField
setFieldset(null $fieldset)

Method to set property fieldset

null
getValue()

Method to get property Value

AbstractField
setValue(null $value)

Method to set property value

AbstractField
description(string $desc)

description

AbstractField
defaultValue(string $value)

defaultValue

mixed
getDefaultValue()

getDefaultValue

AbstractField
setValidator(string|ValidatorInterface $validator)

Method to set property rule

ValidatorInterface
getValidator()

Method to get property Rule

AbstractField
setFilter(string|FilterInterface|callable $filter)

Method to set property filter

string|FilterInterface|callable
getFilter()

Method to get property Filter

string
getControl()

Method to get property Control

AbstractField
setControl(string $control)

Method to set property control

AbstractField
label(string $label)

label

AbstractField
required(bool $value = true)

required

AbstractField
disabled(bool $value = true)

disabled

AbstractField
readonly(bool $value = true)

readonly

AbstractField
setClass(string $value)

class

AbstractField
labelClass(string $value)

labelClass

mixed
getAttribute(string $name, mixed $default = null)

getAttribute

AbstractField
setAttribute(string $name, mixed $value)

getAttribute

mixed
get(string $attr, mixed $default = null)

Get attribute. Alias of getAttribute().

AbstractField
set(string $attr, mixed $value)

set

AbstractField
appendAttribute(string $attr, string $value)

append

AbstractField
prependAttribute(string $attr, string $value)

prependAttribute

mixed
getBool(string $attr, mixed $default = null)

Method to convert some string like true, 1, yes to boolean TRUE, and no, false, disabled, null, none, 0 string to boolean FALSE.

mixed
getFalse(string $attr, mixed $default = null)

Just an alias of getBool() but FALSE will return TRUE.

array
getAttributes()

Get all attributes.

void
def(string $attr, string $value)

If this attribute not exists, use this value as default, or we use original value from xml.

string
getType()

Method to get property Type

Form
getForm()

Method to get property Form

AbstractField
setForm(Form $form)

Method to set property form

string
escape(string $text)

Escape html string.

Details

at line line 166
__construct(string $name = null, string $label = null, array $attributes = array(), string $filter = null, string $validator = null)

Constructor.

Parameters

string $name
string $label
array $attributes
string $filter
string $validator

at line line 192
string renderInput()

getInput

Return Value

string

at line line 211
mixed buildInput(array $attrs)

buildInput

Parameters

array $attrs

Return Value

mixed

at line line 223
abstract array prepare(array $attrs)

prepareRenderInput

Parameters

array $attrs

Return Value

array

at line line 230
array prepareAttributes()

prepareAttributes

Return Value

array

at line line 244
string renderLabel()

getLabel

Return Value

string

at line line 271
string renderView()

renderView

Return Value

string

at line line 281
string render()

render

Return Value

string

at line line 302
mixed getLabel()

getLabel

Return Value

mixed

at line line 312
string getId()

getId

Return Value

string

at line line 324
ValidateResult validate()

validate

Return Value

ValidateResult

at line line 350
mixed checkRequired()

checkRequired

Return Value

mixed

at line line 367
mixed checkRule()

checkRule

Return Value

mixed

at line line 377
AbstractField filter()

filter

Return Value

AbstractField

at line line 398
void prepareStore()

prepareStore

Return Value

void

at line line 409
string getName(bool $withGroup = false)

Method to get property Name

Parameters

bool $withGroup

Return Value

string

at line line 425
AbstractField setName(null $name)

Method to set property name

Parameters

null $name

Return Value

AbstractField Return self to support chaining.

at line line 441
string getFieldName(bool $refresh = false)

Method to get property FieldName

Parameters

bool $refresh

Return Value

string

at line line 475
AbstractField setFieldName(null $fieldName)

Method to set property fieldName

Parameters

null $fieldName

Return Value

AbstractField Return self to support chaining.

at line line 487
null getGroup()

Method to get property Group

Return Value

null

at line line 499
AbstractField setGroup(null $group)

Method to set property group

Parameters

null $group

Return Value

AbstractField Return self to support chaining.

at line line 515
null getFieldset()

Method to get property Fieldset

Return Value

null

at line line 527
AbstractField setFieldset(null $fieldset)

Method to set property fieldset

Parameters

null $fieldset

Return Value

AbstractField Return self to support chaining.

at line line 539
null getValue()

Method to get property Value

Return Value

null

at line line 551
AbstractField setValue(null $value)

Method to set property value

Parameters

null $value

Return Value

AbstractField Return self to support chaining.

at line line 565
AbstractField description(string $desc)

description

Parameters

string $desc

Return Value

AbstractField

at line line 579
AbstractField defaultValue(string $value)

defaultValue

Parameters

string $value

Return Value

AbstractField

at line line 591
mixed getDefaultValue()

getDefaultValue

Return Value

mixed

at line line 603
AbstractField setValidator(string|ValidatorInterface $validator)

Method to set property rule

Parameters

string|ValidatorInterface $validator

Return Value

AbstractField Return self to support chaining.

at line line 615
ValidatorInterface getValidator()

Method to get property Rule

Return Value

ValidatorInterface

at line line 632
AbstractField setFilter(string|FilterInterface|callable $filter)

Method to set property filter

Parameters

string|FilterInterface|callable $filter

Return Value

AbstractField Return self to support chaining.

at line line 644
string|FilterInterface|callable getFilter()

Method to get property Filter

Return Value

string|FilterInterface|callable

at line line 698
string getControl()

Method to get property Control

Return Value

string

at line line 710
AbstractField setControl(string $control)

Method to set property control

Parameters

string $control

Return Value

AbstractField Return self to support chaining.

at line line 728
AbstractField label(string $label)

label

Parameters

string $label

Return Value

AbstractField

at line line 742
AbstractField required(bool $value = true)

required

Parameters

bool $value

Return Value

AbstractField

at line line 758
AbstractField disabled(bool $value = true)

disabled

Parameters

bool $value

Return Value

AbstractField

at line line 772
AbstractField readonly(bool $value = true)

readonly

Parameters

bool $value

Return Value

AbstractField

at line line 786
AbstractField setClass(string $value)

class

Parameters

string $value

Return Value

AbstractField

at line line 800
AbstractField labelClass(string $value)

labelClass

Parameters

string $value

Return Value

AbstractField

at line line 815
mixed getAttribute(string $name, mixed $default = null)

getAttribute

Parameters

string $name
mixed $default

Return Value

mixed

at line line 828
AbstractField setAttribute(string $name, mixed $value)

getAttribute

Parameters

string $name
mixed $value

Return Value

AbstractField

at line line 844
mixed get(string $attr, mixed $default = null)

Get attribute. Alias of getAttribute().

Parameters

string $attr The attribute name.
mixed $default The default value.

Return Value

mixed The return value of this attribute.

at line line 857
AbstractField set(string $attr, mixed $value)

set

Parameters

string $attr
mixed $value

Return Value

AbstractField

at line line 872
AbstractField appendAttribute(string $attr, string $value)

append

Parameters

string $attr
string $value

Return Value

AbstractField

at line line 887
AbstractField prependAttribute(string $attr, string $value)

prependAttribute

Parameters

string $attr
string $value

Return Value

AbstractField

at line line 903
mixed getBool(string $attr, mixed $default = null)

Method to convert some string like true, 1, yes to boolean TRUE, and no, false, disabled, null, none, 0 string to boolean FALSE.

Parameters

string $attr The attribute name.
mixed $default The default value.

Return Value

mixed The return value of this attribute.

at line line 923
mixed getFalse(string $attr, mixed $default = null)

Just an alias of getBool() but FALSE will return TRUE.

Parameters

string $attr The attribute name.
mixed $default The default value.

Return Value

mixed The return value of this attribute.

at line line 933
array getAttributes()

Get all attributes.

Return Value

array The return values of all attributes.

at line line 946
void def(string $attr, string $value)

If this attribute not exists, use this value as default, or we use original value from xml.

Parameters

string $attr The attribute name.
string $value The value to set as default.

Return Value

void

at line line 956
string getType()

Method to get property Type

Return Value

string

at line line 966
Form getForm()

Method to get property Form

Return Value

Form

at line line 978
AbstractField setForm(Form $form)

Method to set property form

Parameters

Form $form

Return Value

AbstractField Return self to support chaining.

at line line 994
string escape(string $text)

Escape html string.

Parameters

string $text

Return Value

string