class TextareaField extends TextField (View source)

The TextareaField 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

mixed
checkRequired()

checkRequired

mixed
checkRule()

checkRule

void
prepareStore()

prepareStore

string
getName(bool $withGroup = false)

Method to get property Name

setName(null $name)

Method to set property name

string
getFieldName(bool $refresh = false)

Method to get property FieldName

setFieldName(null $fieldName)

Method to set property fieldName

null
getGroup()

Method to get property Group

setGroup(null $group)

Method to set property group

null
getFieldset()

Method to get property Fieldset

setFieldset(null $fieldset)

Method to set property fieldset

null
getValue()

Method to get property Value

setValue(null $value)

Method to set property value

description(string $desc)

description

defaultValue(string $value)

defaultValue

mixed
getDefaultValue()

getDefaultValue

setValidator(string|ValidatorInterface $validator)

Method to set property rule

getValidator()

Method to get property Rule

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

setControl(string $control)

Method to set property control

label(string $label)

label

required(bool $value = true)

required

disabled(bool $value = true)

disabled

readonly(bool $value = true)

readonly

setClass(string $value)

class

labelClass(string $value)

labelClass

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

getAttribute

setAttribute(string $name, mixed $value)

getAttribute

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

Get attribute. Alias of getAttribute().

set(string $attr, mixed $value)

set

appendAttribute(string $attr, string $value)

append

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

getForm()

Method to get property Form

setForm(Form $form)

Method to set property form

string
escape(string $text)

Escape html string.

Details

__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

string renderInput()

getInput

Return Value

string

at line line 65
mixed buildInput(array $attrs)

buildInput

Parameters

array $attrs

Return Value

mixed

at line line 41
array prepare(array $attrs)

prepareRenderInput

Parameters

array $attrs

Return Value

array

array prepareAttributes()

prepareAttributes

Return Value

array

string renderLabel()

getLabel

Return Value

string

string renderView()

renderView

Return Value

string

string render()

render

Return Value

string

mixed getLabel()

getLabel

Return Value

mixed

string getId()

getId

Return Value

string

ValidateResult validate()

validate

Return Value

ValidateResult

mixed checkRequired()

checkRequired

Return Value

mixed

mixed checkRule()

checkRule

Return Value

mixed

AbstractField filter()

filter

Return Value

AbstractField

void prepareStore()

prepareStore

Return Value

void

string getName(bool $withGroup = false)

Method to get property Name

Parameters

bool $withGroup

Return Value

string

AbstractField setName(null $name)

Method to set property name

Parameters

null $name

Return Value

AbstractField Return self to support chaining.

string getFieldName(bool $refresh = false)

Method to get property FieldName

Parameters

bool $refresh

Return Value

string

AbstractField setFieldName(null $fieldName)

Method to set property fieldName

Parameters

null $fieldName

Return Value

AbstractField Return self to support chaining.

null getGroup()

Method to get property Group

Return Value

null

AbstractField setGroup(null $group)

Method to set property group

Parameters

null $group

Return Value

AbstractField Return self to support chaining.

null getFieldset()

Method to get property Fieldset

Return Value

null

AbstractField setFieldset(null $fieldset)

Method to set property fieldset

Parameters

null $fieldset

Return Value

AbstractField Return self to support chaining.

null getValue()

Method to get property Value

Return Value

null

AbstractField setValue(null $value)

Method to set property value

Parameters

null $value

Return Value

AbstractField Return self to support chaining.

AbstractField description(string $desc)

description

Parameters

string $desc

Return Value

AbstractField

AbstractField defaultValue(string $value)

defaultValue

Parameters

string $value

Return Value

AbstractField

mixed getDefaultValue()

getDefaultValue

Return Value

mixed

AbstractField setValidator(string|ValidatorInterface $validator)

Method to set property rule

Parameters

string|ValidatorInterface $validator

Return Value

AbstractField Return self to support chaining.

ValidatorInterface getValidator()

Method to get property Rule

Return Value

ValidatorInterface

AbstractField setFilter(string|FilterInterface|callable $filter)

Method to set property filter

Parameters

string|FilterInterface|callable $filter

Return Value

AbstractField Return self to support chaining.

string|FilterInterface|callable getFilter()

Method to get property Filter

Return Value

string|FilterInterface|callable

string getControl()

Method to get property Control

Return Value

string

AbstractField setControl(string $control)

Method to set property control

Parameters

string $control

Return Value

AbstractField Return self to support chaining.

AbstractField label(string $label)

label

Parameters

string $label

Return Value

AbstractField

AbstractField required(bool $value = true)

required

Parameters

bool $value

Return Value

AbstractField

AbstractField disabled(bool $value = true)

disabled

Parameters

bool $value

Return Value

AbstractField

AbstractField readonly(bool $value = true)

readonly

Parameters

bool $value

Return Value

AbstractField

AbstractField setClass(string $value)

class

Parameters

string $value

Return Value

AbstractField

AbstractField labelClass(string $value)

labelClass

Parameters

string $value

Return Value

AbstractField

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

getAttribute

Parameters

string $name
mixed $default

Return Value

mixed

AbstractField setAttribute(string $name, mixed $value)

getAttribute

Parameters

string $name
mixed $value

Return Value

AbstractField

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.

AbstractField set(string $attr, mixed $value)

set

Parameters

string $attr
mixed $value

Return Value

AbstractField

AbstractField appendAttribute(string $attr, string $value)

append

Parameters

string $attr
string $value

Return Value

AbstractField

AbstractField prependAttribute(string $attr, string $value)

prependAttribute

Parameters

string $attr
string $value

Return Value

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.

Parameters

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

Return Value

mixed The return value of this attribute.

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.

array getAttributes()

Get all attributes.

Return Value

array The return values of 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.

Parameters

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

Return Value

void

string getType()

Method to get property Type

Return Value

string

Form getForm()

Method to get property Form

Return Value

Form

AbstractField setForm(Form $form)

Method to set property form

Parameters

Form $form

Return Value

AbstractField Return self to support chaining.

string escape(string $text)

Escape html string.

Parameters

string $text

Return Value

string