\Pop\FormForm

addFilter()

addFilter(\Pop\Form\Filter\FilterInterface  $filter) : \Pop\Form\FormTrait

Add filter

Parameters

Returns

addFilters()

addFilters(array  $filters) : \Pop\Form\FormTrait

Add filters

Parameters

Returns

clearFilters()

clearFilters() : \Pop\Form\FormTrait

Clear filters

Returns

filterValue()

filterValue(mixed  $field) : mixed

Filter value with the filters in the form object

Parameters

Returns

filterValues()

filterValues(array  $values = null) : mixed

Filter values with the filters in the form object

Parameters

Returns

count()

count() : integer

Method to get the count of elements in the form

Returns

toArray()

toArray() : array

Method to get the field values as an array

Returns

getIterator()

getIterator() : \ArrayIterator

Method to iterate over the form elements

Returns

__set()

__set(string  $name, mixed  $value) : void

Set method to set the property to the value of fields[$name]

Parameters

__get()

__get(string  $name) : mixed

Get method to return the value of fields[$name]

Parameters

Throws

\Pop\Form\Exception

Returns

__isset()

__isset(string  $name) : boolean

Return the isset value of fields[$name]

Parameters

Returns

__unset()

__unset(string  $name) : void

Unset fields[$name]

Parameters

offsetExists()

offsetExists(mixed  $offset) : boolean

ArrayAccess offsetExists

Parameters

Returns

offsetGet()

offsetGet(mixed  $offset) : mixed

ArrayAccess offsetGet

Parameters

Returns

offsetSet()

offsetSet(mixed  $offset, mixed  $value) : void

ArrayAccess offsetSet

Parameters

offsetUnset()

offsetUnset(mixed  $offset) : void

ArrayAccess offsetUnset

Parameters

__construct()

__construct(array  $fields = null, string  $action = null, string  $method = 'post') 

Constructor

Instantiate the form object

Parameters

create()

create(string  $name, string  $value = null, array  $options = array()) : \Pop\Dom\Child

Static factory method to create a child object

Parameters

Returns

parseString()

parseString(string  $string) : \Pop\Dom\Child|array

Static method to parse an XML/HTML string

Parameters

Returns

parseFile()

parseFile(string  $file) : \Pop\Dom\Child

Static method to parse an XML/HTML string from a file

Parameters

Throws

\Pop\Dom\Exception

Returns

getNodeName()

getNodeName() : string

Return the child node name

Returns

getNodeValue()

getNodeValue() : string

Return the child node value

Returns

getNodeContent()

getNodeContent(boolean  $ignoreWhiteSpace = false) : string

Return the child node content, including tags, etc

Parameters

Returns

getTextContent()

getTextContent(boolean  $ignoreWhiteSpace = false) : string

Return the child node content, including tags, etc

Parameters

Returns

setNodeName()

setNodeName(string  $name) : \Pop\Dom\Child

Set the child node name

Parameters

Returns

setNodeValue()

setNodeValue(string  $value) : \Pop\Dom\Child

Set the child node value

Parameters

Returns

addNodeValue()

addNodeValue(string  $value) : \Pop\Dom\Child

Add to the child node value

Parameters

Returns

setAsCData()

setAsCData(boolean  $cData = true) : \Pop\Dom\Child

Set the child node value as CDATA

Parameters

Returns

isCData()

isCData() : boolean

Determine if the child node value is CDATA

Returns

setAttribute()

setAttribute(string  $a, string  $v) : \Pop\Form\Form

Method to set an attribute

Parameters

Returns

setAttributes()

setAttributes(array  $a) : \Pop\Form\Form

Method to set attributes

Parameters

Returns

hasAttribute()

hasAttribute(string  $name) : boolean

Determine if the child object has an attribute

Parameters

Returns

getAttribute()

getAttribute(string  $name) : string

Get the attribute of the child object

Parameters

Returns

getAttributes()

getAttributes() : array

Get the attributes of the child object

Returns

removeAttribute()

removeAttribute(string  $a) : \Pop\Dom\Child

Remove an attribute from the child element object

Parameters

Returns

isChildrenFirst()

isChildrenFirst() : boolean

Determine if child nodes render first, before the node value

Returns

setChildrenFirst()

setChildrenFirst(boolean  $first = true) : \Pop\Dom\Child

Set whether child nodes render first, before the node value

Parameters

Returns

preserveWhiteSpace()

preserveWhiteSpace(boolean  $preserve = true) : \Pop\Dom\Child

Set whether to preserve whitespace

Parameters

Returns

render()

render(integer  $depth, string  $indent = null, boolean  $inner = false) : mixed

Render the form object

Parameters

Returns

__toString()

__toString() : string

Render and return the form object as a string

Returns

getIndent()

getIndent() : string

Return the indent

Returns

setIndent()

setIndent(string  $indent) : mixed

Set the indent

Parameters

Returns

getParent()

getParent() : \Pop\Dom\AbstractNode

Return the parent node

Returns

setParent()

setParent(\Pop\Dom\AbstractNode  $parent) : \Pop\Dom\AbstractNode

Set the parent node

Parameters

Returns

addChild()

addChild(mixed  $c) : mixed

Add a child to the object

Parameters

Throws

\InvalidArgumentException

Returns

addChildren()

addChildren(  $children) : mixed

Add children to the object

Parameters

Throws

\Pop\Dom\Exception

Returns

hasChildren()

hasChildren() : boolean

Get whether or not the child object has children

Returns

hasChildNodes()

hasChildNodes() : boolean

Get whether or not the child object has children (alias)

Returns

getChild()

getChild(integer  $i) : \Pop\Dom\Child

Get the child nodes of the object

Parameters

Returns

getChildren()

getChildren() : array

Get the child nodes of the object

Returns

getChildNodes()

getChildNodes() : array

Get the child nodes of the object (alias)

Returns

removeChild()

removeChild(integer  $i) : void

Remove all child nodes from the object

Parameters

removeChildren()

removeChildren() : void

Remove all child nodes from the object

createFromConfig()

createFromConfig(array  $config, string  $action = null, string  $method = 'post') : \Pop\Form\Form

Method to create form object and fields from config

Parameters

Returns

createFromFieldsetConfig()

createFromFieldsetConfig(array  $config, string  $container = null, string  $action = null, string  $method = 'post') : \Pop\Form\Form

Method to create form object and fields from config

Parameters

Returns

createFieldset()

createFieldset(string  $legend = null, string  $container = null) : \Pop\Form\Fieldset

Method to create a new fieldset object

Parameters

Returns

setAction()

setAction(string  $action) : \Pop\Form\Form

Method to set action

Parameters

Returns

setMethod()

setMethod(string  $method) : \Pop\Form\Form

Method to set method

Parameters

Returns

getAction()

getAction() : string

Method to get action

Returns

getMethod()

getMethod() : string

Method to get method

Returns

addFieldset()

addFieldset(\Pop\Form\Fieldset  $fieldset) : \Pop\Form\Form

Method to add fieldset

Parameters

Returns

removeFieldset()

removeFieldset(integer  $i) : \Pop\Form\Form

Method to remove fieldset

Parameters

Returns

getFieldset()

getFieldset() : \Pop\Form\Fieldset

Method to get current fieldset

Returns

addColumn()

addColumn(mixed  $fieldsets, string  $class = null) : \Pop\Form\Form

Method to add form column

Parameters

Returns

hasColumn()

hasColumn(string  $class) : boolean

Method to determine if form has a column

Parameters

Returns

getColumn()

getColumn(string  $class) : array

Method to get form column

Parameters

Returns

removeColumn()

removeColumn(string  $class) : \Pop\Form\Form

Method to remove form column

Parameters

Returns

getCurrent()

getCurrent() : integer

Method to get current fieldset index

Returns

setCurrent()

setCurrent(integer  $i) : \Pop\Form\Form

Method to get current fieldset index

Parameters

Returns

getLegend()

getLegend() : string

Method to get the legend of the current fieldset

Returns

setLegend()

setLegend(string  $legend) : \Pop\Form\Form

Method to set the legend of the current fieldset

Parameters

Returns

addField()

addField(\Pop\Form\Element\AbstractElement  $field) : \Pop\Form\Form

Method to add a form field

Parameters

Returns

addFields()

addFields(array  $fields) : \Pop\Form\Form

Method to add form fields

Parameters

Returns

addFieldFromConfig()

addFieldFromConfig(string  $name, array  $field) : \Pop\Form\Form

Method to add a form field from a config

Parameters

Returns

addFieldsFromConfig()

addFieldsFromConfig(array  $config) : \Pop\Form\Form

Method to add form fields from config

Parameters

Returns

addFieldsetsFromConfig()

addFieldsetsFromConfig(array  $fieldsets, string  $container = null) : \Pop\Form\Form

Method to add form fieldsets from config

Parameters

Returns

insertFieldBefore()

insertFieldBefore(string  $name, \Pop\Form\Element\AbstractElement  $field) : \Pop\Form\Form

Method to insert a field before another one

Parameters

Returns

insertFieldAfter()

insertFieldAfter(string  $name, \Pop\Form\Element\AbstractElement  $field) : \Pop\Form\Form

Method to insert a field after another one

Parameters

Returns

getField()

getField(string  $name) : \Pop\Form\Element\AbstractElement

Method to get a field element object

Parameters

Returns

getFields()

getFields() : array

Method to get field element objects

Returns

removeField()

removeField(string  $field) : \Pop\Form\Form

Method to remove a form field

Parameters

Returns

getFieldValue()

getFieldValue(string  $name) : mixed

Method to get a field element value

Parameters

Returns

setFieldValue()

setFieldValue(string  $name, mixed  $value) : \Pop\Form\Form

Method to set a field element value

Parameters

Returns

setFieldValues()

setFieldValues(array  $values) : \Pop\Form\Form

Method to set field element values

Parameters

Returns

isValid()

isValid() : boolean

Determine whether or not the form object is valid

Returns

getErrors()

getErrors(string  $name) : array

Get form element errors for a field.

Parameters

Returns

getAllErrors()

getAllErrors() : array

Get all form element errors

Returns

reset()

reset() : \Pop\Form\Form

Method to reset and clear any form field values

Returns

clearTokens()

clearTokens() : \Pop\Form\Form

Method to clear any security tokens

Returns

prepare()

prepare() : \Pop\Form\Form

Prepare form object for rendering

Returns

prepareForView()

prepareForView() : array

Prepare form object for rendering with a view

Returns