$template
$template : \Pop\Form\Template\TemplateInterface
Form template
Form class
$template : \Pop\Form\Template\TemplateInterface
Form template
setTemplate(string $template) : \Pop\Form\Form
Set a form template
string | $template |
setAction(string $action) : \Pop\Form\Form
Set the form action
string | $action |
setMethod(string $method) : \Pop\Form\Form
Set the form method
string | $method |
addFilter(mixed $call, mixed $params = null, mixed $excludeByType = null, mixed $excludeByName = null) : \Pop\Form\AbstractForm
Add filter
mixed | $call | |
mixed | $params | |
mixed | $excludeByType | |
mixed | $excludeByName |
addFilters(array $filters, mixed $excludeByType = null, mixed $excludeByName = null) : \Pop\Form\AbstractForm
Add filters
array | $filters | |
mixed | $excludeByType | |
mixed | $excludeByName |
clearFilters() : \Pop\Form\AbstractForm
Clear filters
getTemplate() : \Pop\Form\Template\TemplateInterface
Get the form template for the render method to utilize.
element(string $elementName) : \Pop\Form\Element\AbstractElement
Alias method to getElement()
string | $elementName |
getElement(string $elementName) : \Pop\Form\Element\AbstractElement
Get an element object of the form by name.
string | $elementName |
clear() : \Pop\Form\Form
Method to clear any session data used with the form for security tokens, captchas, etc.
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
array | $values |
filter() : \Pop\Form\Form
Filter of field values with the filters that have been set
__construct(array $fields = null, string $action = null, string $method = 'post') : \Pop\Form\Form
Constructor
Instantiate the form object
array | $fields | |
string | $action | |
string | $method |
factory(array $c) : \Pop\Dom\Child
Static factory method to create a child object
array | $c |
setNodeName(string $name) : \Pop\Dom\Child
Set the child node name.
string | $name |
setNodeValue(string $value) : \Pop\Dom\Child
Set the child node value.
string | $value |
setAttribute(string $a, string $v) : \Pop\Dom\Child
Set an attribute for the child element object.
string | $a | |
string | $v |
setAttributes(array $a) : \Pop\Dom\Child
Set an attribute or attributes for the child element object.
array | $a |
removeAttribute(string $a) : \Pop\Dom\Child
Remove an attribute from the child element object
string | $a |
getChild(integer $i) : \Pop\Dom\Child
Get the child nodes of the object.
integer | $i |
setFieldConfig(array $fields) : \Pop\Form\Form
Set the field config
array | $fields |
addFieldConfig(string $name, array $field) : \Pop\Form\Form
Add a single field config
string | $name | |
array | $field |
addFieldConfigs(array $fields) : \Pop\Form\Form
Add multiple field configs
array | $fields |
insertFieldConfigBefore(string $before, string $name, array $field) : \Pop\Form\Form
Insert a field config before another field config
string | $before | |
string | $name | |
array | $field |
insertFieldConfigAfter(string $after, string $name, array $field) : \Pop\Form\Form
Insert a field config before another field config
string | $after | |
string | $name | |
array | $field |
insertGroupConfigBefore(string $beforeIndex, array $fieldGroup) : \Pop\Form\Form
Insert a field group config before another field group config
string | $beforeIndex | |
array | $fieldGroup |
insertGroupConfigAfter(string $afterIndex, array $fieldGroup) : \Pop\Form\Form
Insert a field group config after another field group config
string | $afterIndex | |
array | $fieldGroup |
insertElementBefore(string $name, \Pop\Form\Element\AbstractElement $e) : \Pop\Form\Form
Insert a form element before another element
string | $name | |
\Pop\Form\Element\AbstractElement | $e |
insertElementAfter(string $name, \Pop\Form\Element\AbstractElement $e) : \Pop\Form\Form
Insert a form element after another element
string | $name | |
\Pop\Form\Element\AbstractElement | $e |
addElement(\Pop\Form\Element\AbstractElement $e) : \Pop\Form\Form
Add a form element or elements to the form object.
\Pop\Form\Element\AbstractElement | $e |
addElements(array $e) : \Pop\Form\Form
Add a form element or elements to the form object.
array | $e |
setErrorDisplay(string $container, array $attribs, boolean $pre = false) : \Pop\Form\Form
Set error pre-display globally across all form element objects
string | $container | |
array | $attribs | |
boolean | $pre |