\Pop\FormForm

setTemplate()

setTemplate(string  $template) : \Pop\Form\Form

Set a form template

Parameters

Returns

setAction()

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

Set the form action

Parameters

Returns

setMethod()

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

Set the form method

Parameters

Returns

addFilter()

addFilter(mixed  $call, mixed  $params = null, mixed  $excludeByType = null, mixed  $excludeByName = null) : \Pop\Form\AbstractForm

Add filter

Parameters

Returns

addFilters()

addFilters(array  $filters, mixed  $excludeByType = null, mixed  $excludeByName = null) : \Pop\Form\AbstractForm

Add filters

Parameters

Throws

\Pop\Form\Exception

Returns

clearFilters()

clearFilters() : \Pop\Form\AbstractForm

Clear filters

Returns

addHeader()

addHeader(string  $header, integer  $weight = 1, integer  $position = null) : \Pop\Form\AbstractForm

Add field group header

Parameters

Returns

removeHeader()

removeHeader(string  $header) : \Pop\Form\AbstractForm

Remove field group header

Parameters

Returns

removeHeaderByPosition()

removeHeaderByPosition(integer  $position) : \Pop\Form\AbstractForm

Remove field group header

Parameters

Returns

getTemplate()

getTemplate() : \Pop\Form\Template\TemplateInterface

Get the form template for the render method to utilize.

Returns

hasFile()

hasFile() : boolean

Get the $hasFile property

Returns

getAction()

getAction() : array

Get the form action

Returns

getMethod()

getMethod() : array

Get the form method

Returns

getFields()

getFields() : array

Get the form fields

Returns

elements()

elements() : array

Alias method to getElements())

Returns

getElements()

getElements() : array

Get the elements of the form object.

Returns

element()

element(string  $elementName) : \Pop\Form\Element\AbstractElement

Alias method to getElement()

Parameters

Returns

getElement()

getElement(string  $elementName) : \Pop\Form\Element\AbstractElement

Get an element object of the form by name.

Parameters

Returns

getElementIndex()

getElementIndex(string  $elementName) : integer

Get the index of an element object of the form by name.

Parameters

Returns

getFieldConfig()

getFieldConfig(  $name = null) : array

Get fieldConfig

Parameters

Returns

getFieldGroupConfig()

getFieldGroupConfig() : array

Get fieldGroupConfig

Returns

hasFieldGroupConfig()

hasFieldGroupConfig() : boolean

Determine if the for has group field configs

Returns

clear()

clear() : \Pop\Form\Form

Method to clear any session data used with the form for security tokens, captchas, etc.

Returns

__set()

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

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

Parameters

Throws

\Pop\Form\Exception

__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

setFieldValues()

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

Set the field values. Optionally, you can apply filters to the passed values via callbacks and their parameters

Parameters

Returns

filter()

filter() : \Pop\Form\Form

Filter of field values with the filters that have been set

Returns

__construct()

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

Constructor

Instantiate the form object

Parameters

Returns

factory()

factory(array  $c) : \Pop\Dom\Child

Static factory method to create a child object

Parameters

Throws

\Pop\Dom\Exception

Returns

getNodeName()

getNodeName() : string

Return the child node name.

Returns

getNodeValue()

getNodeValue() : string

Return the child node value.

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

setAttribute()

setAttribute(string  $a, string  $v) : \Pop\Dom\Child

Set an attribute for the child element object.

Parameters

Returns

setAttributes()

setAttributes(array  $a) : \Pop\Dom\Child

Set an attribute or attributes for the child element object.

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

render()

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

Render the child and its child nodes.

Parameters

Returns

__toString()

__toString() : string

Output the form object as a string

Returns

getIndent()

getIndent() : string

Return the indent.

Returns

setIndent()

setIndent(string  $indent) : mixed

Set the indent.

Parameters

Returns

addChild()

addChild(mixed  $c) : mixed

Add a child to the object.

Parameters

Throws

\InvalidArgumentException

Returns

addChildren()

addChildren(array  $c) : 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

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

removeChild()

removeChild(integer  $i) : void

Remove all child nodes from the object.

Parameters

removeChildren()

removeChildren() : void

Remove all child nodes from the object.

setFieldConfig()

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

Set the field config

Parameters

Returns

addFieldConfig()

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

Add a single field config

Parameters

Returns

addFieldConfigs()

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

Add multiple field configs

Parameters

Returns

insertFieldConfigBefore()

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

Insert a field config before another field config

Parameters

Throws

\Pop\Form\Exception

Returns

insertFieldConfigAfter()

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

Insert a field config before another field config

Parameters

Throws

\Pop\Form\Exception

Returns

insertGroupConfigBefore()

insertGroupConfigBefore(string  $beforeIndex, array  $fieldGroup) : \Pop\Form\Form

Insert a field group config before another field group config

Parameters

Throws

\Pop\Form\Exception

Returns

insertGroupConfigAfter()

insertGroupConfigAfter(string  $afterIndex, array  $fieldGroup) : \Pop\Form\Form

Insert a field group config after another field group config

Parameters

Throws

\Pop\Form\Exception

Returns

insertElementBefore()

insertElementBefore(string  $name, \Pop\Form\Element\AbstractElement  $e) : \Pop\Form\Form

Insert a form element before another element

Parameters

Throws

\Pop\Form\Exception

Returns

insertElementAfter()

insertElementAfter(string  $name, \Pop\Form\Element\AbstractElement  $e) : \Pop\Form\Form

Insert a form element after another element

Parameters

Throws

\Pop\Form\Exception

Returns

addElement()

addElement(\Pop\Form\Element\AbstractElement  $e) : \Pop\Form\Form

Add a form element or elements to the form object.

Parameters

Returns

addElements()

addElements(array  $e) : \Pop\Form\Form

Add a form element or elements to the form object.

Parameters

Throws

\Pop\Form\Exception

Returns

removeElement()

removeElement(string  $elementName) : $this

Remove a form element

Parameters

Returns

isValid()

isValid() : boolean

Determine whether or not the form object is valid and return the result.

Returns

setErrorDisplay()

setErrorDisplay(string  $container, array  $attribs, boolean  $pre = false) : \Pop\Form\Form

Set error pre-display globally across all form element objects

Parameters

Returns

hasErrors()

hasErrors(string  $field = null) : boolean

Check if form has errors

Parameters

Returns

getErrors()

getErrors(string  $field = null) : array

Get all form element errors.

Parameters

Returns

renderForm()

renderForm(boolean  $ret = false) : mixed

Render the form object either using the defined template or by a basic 1:1 DT/DD tag structure.

Parameters

Throws

\Pop\Form\Exception

Returns

filterValues()

filterValues(array  $values = null) : mixed

Method to filter the values with the applied callbacks and their parameters

Parameters

Returns

applyFilter()

applyFilter(array  $array, string  $call, array  $params = array()) : void

Execute filter

Parameters

createFields()

createFields(array  $values = null) : void

Method to create the form fields

Parameters

Throws

\Pop\Form\Exception

isFieldGroupConfig()

isFieldGroupConfig(array  $fields) : boolean

Method to determine if the field config passed is a field group

Parameters

Returns

renderWithoutTemplate()

renderWithoutTemplate() : string

Method to render the form using a basic 1:1 DT/DD layout

Returns