FormTrait uses trait:short
Form trait
Tags
Table of Contents
Properties
- $filters : array<string|int, mixed>
- Form filters
Methods
- __get() : mixed
- Get method to return the value of values[$name]
- __isset() : bool
- Return the isset value of values[$name]
- __set() : void
- Set method to set the property to the value of values[$name]
- __unset() : void
- Unset values[$name]
- addFilter() : static
- Add filter
- addFilters() : static
- Add filters
- clearFilters() : static
- Clear filters
- count() : int
- Count of values
- filter() : mixed
- Filter values
- filterAll() : array<string|int, mixed>
- Filter all values, ignoring excludes
- filterEach() : array<string|int, mixed>
- Filter each value, keyed by name, honoring each filter's excludeByName rules
- getFilters() : array<string|int, mixed>
- Get filters
- getIterator() : ArrayIterator
- Method to iterate over the form elements
- hasFilter() : bool
- Has filter
- hasFilters() : bool
- Has filters
- offsetExists() : bool
- ArrayAccess offsetExists
- offsetGet() : mixed
- ArrayAccess offsetGet
- offsetSet() : void
- ArrayAccess offsetSet
- offsetUnset() : void
- ArrayAccess offsetUnset
- removeFilter() : static
- Remove filter
- toArray() : array<string|int, mixed>
- Get values
Properties
$filters
Form filters
protected
array<string|int, mixed>
$filters
= []
Methods
__get()
Get method to return the value of values[$name]
public
abstract __get(string $name) : mixed
Parameters
- $name : string
__isset()
Return the isset value of values[$name]
public
abstract __isset(string $name) : bool
Parameters
- $name : string
Return values
bool__set()
Set method to set the property to the value of values[$name]
public
abstract __set(string $name, mixed $value) : void
Parameters
- $name : string
- $value : mixed
__unset()
Unset values[$name]
public
abstract __unset(string $name) : void
Parameters
- $name : string
addFilter()
Add filter
public
addFilter(mixed $filter) : static
Parameters
- $filter : mixed
Tags
Return values
staticaddFilters()
Add filters
public
addFilters(array<string|int, mixed> $filters) : static
Parameters
- $filters : array<string|int, mixed>
Return values
staticclearFilters()
Clear filters
public
clearFilters() : static
Return values
staticcount()
Count of values
public
abstract count() : int
Return values
intfilter()
Filter values
public
abstract filter(mixed $values) : mixed
Parameters
- $values : mixed
filterAll()
Filter all values, ignoring excludes
public
filterAll(array<string|int, mixed> $values) : array<string|int, mixed>
Parameters
- $values : array<string|int, mixed>
Return values
array<string|int, mixed>filterEach()
Filter each value, keyed by name, honoring each filter's excludeByName rules
public
filterEach(array<string|int, mixed> $values) : array<string|int, mixed>
Parameters
- $values : array<string|int, mixed>
Return values
array<string|int, mixed>getFilters()
Get filters
public
getFilters() : array<string|int, mixed>
Return values
array<string|int, mixed>getIterator()
Method to iterate over the form elements
public
getIterator() : ArrayIterator
Return values
ArrayIteratorhasFilter()
Has filter
public
hasFilter(FilterInterface $filter) : bool
Parameters
- $filter : FilterInterface
Return values
boolhasFilters()
Has filters
public
hasFilters() : bool
Return values
booloffsetExists()
ArrayAccess offsetExists
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
ArrayAccess offsetGet
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
offsetSet()
ArrayAccess offsetSet
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
offsetUnset()
ArrayAccess offsetUnset
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
removeFilter()
Remove filter
public
removeFilter(FilterInterface $filter) : static
Parameters
- $filter : FilterInterface
Return values
statictoArray()
Get values
public
abstract toArray() : array<string|int, mixed>