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

RadioField

class RadioField extends ListField (View source)

The RadioField class.

Methods

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

No description

from ListField
string
renderInput()

getInput

from AbstractField
mixed
buildInput(array $attrs)

buildInput

array
prepare(array $attrs)

prepareRenderInput

from ListField
array
prepareAttributes()

prepareAttributes

from AbstractField
string
renderLabel()

getLabel

from AbstractField
string
renderView()

renderView

from AbstractField
string
render()

render

from AbstractField
mixed
getLabel()

getLabel

from AbstractField
string
getId()

getId

from AbstractField
ValidateResult
validate()

validate

from AbstractField
mixed
checkRequired()

checkRequired

from AbstractField
mixed
checkRule()

checkRule

from AbstractField
AbstractField
filter()

filter

from AbstractField
void
prepareStore()

prepareStore

from AbstractField
string
getName(bool $withGroup = false)

Method to get property Name

from AbstractField
AbstractField
setName(null $name)

Method to set property name

from AbstractField
string
getFieldName(bool $refresh = false)

Method to get property FieldName

from AbstractField
AbstractField
setFieldName(null $fieldName)

Method to set property fieldName

from AbstractField
null
getGroup()

Method to get property Group

from AbstractField
AbstractField
setGroup(null $group)

Method to set property group

from AbstractField
null
getFieldset()

Method to get property Fieldset

from AbstractField
AbstractField
setFieldset(null $fieldset)

Method to set property fieldset

from AbstractField
null
getValue()

getValue

from ListField
AbstractField
setValue(null $value)

Method to set property value

from AbstractField
AbstractField
description(string $desc)

description

from AbstractField
AbstractField
defaultValue(string $value)

defaultValue

from AbstractField
mixed
getDefaultValue()

getDefaultValue

from AbstractField
AbstractField
setValidator(string|ValidatorInterface $validator)

Method to set property rule

from AbstractField
ValidatorInterface
getValidator()

Method to get property Rule

from AbstractField
AbstractField
setFilter(string|FilterInterface|callable $filter)

Method to set property filter

from AbstractField
string|FilterInterface|callable
getFilter()

Method to get property Filter

from AbstractField
string
getControl()

Method to get property Control

from AbstractField
AbstractField
setControl(string $control)

Method to set property control

from AbstractField
AbstractField
label(string $label)

label

from AbstractField
AbstractField
required(bool $value = true)

required

from AbstractField
AbstractField
disabled(bool $value = true)

disabled

from AbstractField
AbstractField
readonly(bool $value = true)

readonly

from AbstractField
AbstractField
setClass(string $value)

class

from AbstractField
AbstractField
labelClass(string $value)

labelClass

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

getAttribute

from AbstractField
AbstractField
setAttribute(string $name, mixed $value)

getAttribute

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

Get attribute. Alias of getAttribute().

from AbstractField
AbstractField
set(string $attr, mixed $value)

set

from AbstractField
AbstractField
appendAttribute(string $attr, string $value)

append

from AbstractField
AbstractField
prependAttribute(string $attr, string $value)

prependAttribute

from AbstractField
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.

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

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

from AbstractField
array
getAttributes()

Get all attributes.

from AbstractField
void
def(string $attr, string $value)

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

from AbstractField
string
getType()

Method to get property Type

from AbstractField
Form
getForm()

Method to get property Form

from AbstractField
AbstractField
setForm(Form $form)

Method to set property form

from AbstractField
string
escape(string $text)

Escape html string.

from AbstractField
array|Option[]
getOptions()

getOptions

from ListField
ListField
setOptions($options, $group = null)

setOptions

from ListField
ListField
addOption(Option $option, string $group = null)

addOption

from ListField
ListField
option(string $text = null, string $value = null, array $attribs = array(), string $group = null)

option

from ListField
ListField
group(string $name, Closure $callback)

optionGroup

from ListField

Details

in ListField at line line 51
__construct(string $name = null, string $label = null, array $options = array(), array $attributes = array(), string $filter = null, null $rule = null)

Parameters

string $name
string $label
array $options
array $attributes
string $filter
null $rule

in AbstractField at line line 192
string renderInput()

getInput

Return Value

string

at line line 34
mixed buildInput(array $attrs)

buildInput

Parameters

array $attrs

Return Value

mixed

in ListField at line line 65
array prepare(array $attrs)

prepareRenderInput

Parameters

array $attrs

Return Value

array

in AbstractField at line line 230
array prepareAttributes()

prepareAttributes

Return Value

array

in AbstractField at line line 244
string renderLabel()

getLabel

Return Value

string

in AbstractField at line line 271
string renderView()

renderView

Return Value

string

in AbstractField at line line 281
string render()

render

Return Value

string

in AbstractField at line line 302
mixed getLabel()

getLabel

Return Value

mixed

in AbstractField at line line 312
string getId()

getId

Return Value

string

in AbstractField at line line 324
ValidateResult validate()

validate

Return Value

ValidateResult

in AbstractField at line line 350
mixed checkRequired()

checkRequired

Return Value

mixed

in AbstractField at line line 367
mixed checkRule()

checkRule

Return Value

mixed

in AbstractField at line line 377
AbstractField filter()

filter

Return Value

AbstractField

in AbstractField at line line 398
void prepareStore()

prepareStore

Return Value

void

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

Method to get property Name

Parameters

bool $withGroup

Return Value

string

in AbstractField at line line 425
AbstractField setName(null $name)

Method to set property name

Parameters

null $name

Return Value

AbstractField Return self to support chaining.

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

Method to get property FieldName

Parameters

bool $refresh

Return Value

string

in AbstractField at line line 475
AbstractField setFieldName(null $fieldName)

Method to set property fieldName

Parameters

null $fieldName

Return Value

AbstractField Return self to support chaining.

in AbstractField at line line 487
null getGroup()

Method to get property Group

Return Value

null

in AbstractField at line line 499
AbstractField setGroup(null $group)

Method to set property group

Parameters

null $group

Return Value

AbstractField Return self to support chaining.

in AbstractField at line line 515
null getFieldset()

Method to get property Fieldset

Return Value

null

in AbstractField at line line 527
AbstractField setFieldset(null $fieldset)

Method to set property fieldset

Parameters

null $fieldset

Return Value

AbstractField Return self to support chaining.

in ListField at line line 273
null getValue()

getValue

Return Value

null

in AbstractField at line line 551
AbstractField setValue(null $value)

Method to set property value

Parameters

null $value

Return Value

AbstractField Return self to support chaining.

in AbstractField at line line 565
AbstractField description(string $desc)

description

Parameters

string $desc

Return Value

AbstractField

in AbstractField at line line 579
AbstractField defaultValue(string $value)

defaultValue

Parameters

string $value

Return Value

AbstractField

in AbstractField at line line 591
mixed getDefaultValue()

getDefaultValue

Return Value

mixed

in AbstractField 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.

in AbstractField at line line 615
ValidatorInterface getValidator()

Method to get property Rule

Return Value

ValidatorInterface

in AbstractField 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.

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

Method to get property Filter

Return Value

string|FilterInterface|callable

in AbstractField at line line 698
string getControl()

Method to get property Control

Return Value

string

in AbstractField at line line 710
AbstractField setControl(string $control)

Method to set property control

Parameters

string $control

Return Value

AbstractField Return self to support chaining.

in AbstractField at line line 728
AbstractField label(string $label)

label

Parameters

string $label

Return Value

AbstractField

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

required

Parameters

bool $value

Return Value

AbstractField

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

disabled

Parameters

bool $value

Return Value

AbstractField

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

readonly

Parameters

bool $value

Return Value

AbstractField

in AbstractField at line line 786
AbstractField setClass(string $value)

class

Parameters

string $value

Return Value

AbstractField

in AbstractField at line line 800
AbstractField labelClass(string $value)

labelClass

Parameters

string $value

Return Value

AbstractField

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

getAttribute

Parameters

string $name
mixed $default

Return Value

mixed

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

getAttribute

Parameters

string $name
mixed $value

Return Value

AbstractField

in 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.

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

set

Parameters

string $attr
mixed $value

Return Value

AbstractField

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

append

Parameters

string $attr
string $value

Return Value

AbstractField

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

prependAttribute

Parameters

string $attr
string $value

Return Value

AbstractField

in 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.

in AbstractField 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.

in AbstractField at line line 933
array getAttributes()

Get all attributes.

Return Value

array The return values of all attributes.

in AbstractField 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

in AbstractField at line line 956
string getType()

Method to get property Type

Return Value

string

in AbstractField at line line 966
Form getForm()

Method to get property Form

Return Value

Form

in AbstractField at line line 978
AbstractField setForm(Form $form)

Method to set property form

Parameters

Form $form

Return Value

AbstractField Return self to support chaining.

in AbstractField at line line 994
string escape(string $text)

Escape html string.

Parameters

string $text

Return Value

string

in ListField at line line 99
array|Option[] getOptions()

getOptions

Return Value

array|Option[]

in ListField at line line 111
ListField setOptions($options, $group = null)

setOptions

Parameters

$options
$group

Return Value

ListField

in ListField at line line 131
ListField addOption(Option $option, string $group = null)

addOption

Parameters

Option $option
string $group

Return Value

ListField

in ListField at line line 155
ListField option(string $text = null, string $value = null, array $attribs = array(), string $group = null)

option

Parameters

string $text
string $value
array $attribs
string $group

Return Value

ListField

in ListField at line line 170
ListField group(string $name, Closure $callback)

optionGroup

Parameters

string $name
Closure $callback

Return Value

ListField