PHP Класс Pop\Form\Form

Автор: Nick Sagona, III ([email protected])
Наследование: extends Pop\Dom\Dom
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$action string Form action
$errorDisplay array Global Form error display format
$fields array Form field values
$form Pop\Dom\Child Form element node
$groups array Form field groups
$hasFile boolean Has file flag
$initFieldsValues array Form init field values
$method string Form method
$template string Form template for HTML formatting.

Открытые методы

Метод Описание
__construct ( string $action = null, string $method = 'post', array $fields = null, string $indent = null ) : Form Constructor
__get ( string $name ) : mixed Get method to return the value of fields[$name].
__isset ( string $name ) : boolean Return the isset value of fields[$name].
__set ( string $name, mixed $value ) : void Set method to set the property to the value of fields[$name].
__toString ( ) : string Output the form object as a string
__unset ( string $name ) : void Unset fields[$name].
addElements ( mixed $e ) : Form Add a form element or elements to the form object.
addFields ( array $fields ) : Form Alias for setFields()
clear ( ) : Form Method to clear any session data used with the form for security tokens, captchas, etc.
factory ( string $action = null, string $method = 'post', array $fields = null, string $indent = null ) : Form Static method to instantiate the form object and return itself to facilitate chaining methods together.
filter ( array $filters ) : Form Method to filter current form values with the applied callbacks and their parameters
getAction ( ) : array Get the form action.
getAttributes ( ) : array Get the attributes of the form object.
getElement ( string $elementName ) : Element Get an element object of the form by name.
getElementIndex ( string $elementName ) : integer Get the index of an element object of the form by name.
getElements ( ) : array Get the elements of the form object.
getErrors ( ) : array Get all form element errors.
getField ( $name ) : array Get a single field from $initFieldsValues
getFields ( ) : array Get the form fields
getFormElement ( ) : array Get the main form element.
getMethod ( ) : array Get the form method.
getTemplate ( ) : string Get the form template for the render method to utilize.
hasFile ( ) : boolean Get the $hasFile property
isValid ( ) : boolean Determine whether or not the form object is valid and return the result.
removeElement ( string $elementName ) Remove a form element
render ( boolean $ret = false ) : void Render the form object either using the defined template or by a basic 1:1 DT/DD tag structure.
setAction ( string $action ) : Form Set the form action.
setAttributes ( array | string $a, string $v = null ) : Form Set an attribute or attributes for the form object.
setErrorDisplay ( string $container, array $attribs, boolean $pre = false ) : Form Set error pre-display globally across all form element objects
setField ( string $name, array $field ) : Form Set a single field in $initFieldsValues
setFieldValues ( array $values = null, array $filters = null ) : Form Set the field values. Optionally, you can apply filters to the passed values via callbacks and their parameters
setFields ( array $fields ) : Form Set the fields of the form object.
setMethod ( string $method ) : Form Set the form method.
setTemplate ( string $tmpl ) : Form Set a form template for the render method to utilize.

Защищенные методы

Метод Описание
filterValues ( array $values, array $filters ) : array Method to filter the values with the applied callbacks and their parameters
renderWithTemplate ( ) : void Method to render the form using the template
renderWithoutTemplate ( ) : void Method to render the form using a basic 1:1 DT/DD layout

Описание методов

__construct() публичный Метод

Instantiate the form object
public __construct ( string $action = null, string $method = 'post', array $fields = null, string $indent = null ) : Form
$action string
$method string
$fields array
$indent string
Результат Form

__get() публичный Метод

Get method to return the value of fields[$name].
public __get ( string $name ) : mixed
$name string
Результат mixed

__isset() публичный Метод

Return the isset value of fields[$name].
public __isset ( string $name ) : boolean
$name string
Результат boolean

__set() публичный Метод

Set method to set the property to the value of fields[$name].
public __set ( string $name, mixed $value ) : void
$name string
$value mixed
Результат void

__toString() публичный Метод

Output the form object as a string
public __toString ( ) : string
Результат string

__unset() публичный Метод

Unset fields[$name].
public __unset ( string $name ) : void
$name string
Результат void

addElements() публичный Метод

Add a form element or elements to the form object.
public addElements ( mixed $e ) : Form
$e mixed
Результат Form

addFields() публичный Метод

Alias for setFields()
public addFields ( array $fields ) : Form
$fields array
Результат Form

clear() публичный Метод

Method to clear any session data used with the form for security tokens, captchas, etc.
public clear ( ) : Form
Результат Form

factory() публичный статический Метод

Static method to instantiate the form object and return itself to facilitate chaining methods together.
public static factory ( string $action = null, string $method = 'post', array $fields = null, string $indent = null ) : Form
$action string
$method string
$fields array
$indent string
Результат Form

filter() публичный Метод

Method to filter current form values with the applied callbacks and their parameters
public filter ( array $filters ) : Form
$filters array
Результат Form

filterValues() защищенный Метод

Method to filter the values with the applied callbacks and their parameters
protected filterValues ( array $values, array $filters ) : array
$values array
$filters array
Результат array

getAction() публичный Метод

Get the form action.
public getAction ( ) : array
Результат array

getAttributes() публичный Метод

Get the attributes of the form object.
public getAttributes ( ) : array
Результат array

getElement() публичный Метод

Get an element object of the form by name.
public getElement ( string $elementName ) : Element
$elementName string
Результат Element

getElementIndex() публичный Метод

Get the index of an element object of the form by name.
public getElementIndex ( string $elementName ) : integer
$elementName string
Результат integer

getElements() публичный Метод

Get the elements of the form object.
public getElements ( ) : array
Результат array

getErrors() публичный Метод

Get all form element errors.
public getErrors ( ) : array
Результат array

getField() публичный Метод

Get a single field from $initFieldsValues
public getField ( $name ) : array
$name
Результат array

getFields() публичный Метод

Get the form fields
public getFields ( ) : array
Результат array

getFormElement() публичный Метод

Get the main form element.
public getFormElement ( ) : array
Результат array

getMethod() публичный Метод

Get the form method.
public getMethod ( ) : array
Результат array

getTemplate() публичный Метод

Get the form template for the render method to utilize.
public getTemplate ( ) : string
Результат string

hasFile() публичный Метод

Get the $hasFile property
public hasFile ( ) : boolean
Результат boolean

isValid() публичный Метод

Determine whether or not the form object is valid and return the result.
public isValid ( ) : boolean
Результат boolean

removeElement() публичный Метод

Remove a form element
public removeElement ( string $elementName )
$elementName string

render() публичный Метод

Render the form object either using the defined template or by a basic 1:1 DT/DD tag structure.
public render ( boolean $ret = false ) : void
$ret boolean
Результат void

renderWithTemplate() защищенный Метод

Method to render the form using the template
protected renderWithTemplate ( ) : void
Результат void

renderWithoutTemplate() защищенный Метод

Method to render the form using a basic 1:1 DT/DD layout
protected renderWithoutTemplate ( ) : void
Результат void

setAction() публичный Метод

Set the form action.
public setAction ( string $action ) : Form
$action string
Результат Form

setAttributes() публичный Метод

Set an attribute or attributes for the form object.
public setAttributes ( array | string $a, string $v = null ) : Form
$a array | string
$v string
Результат Form

setErrorDisplay() публичный Метод

Set error pre-display globally across all form element objects
public setErrorDisplay ( string $container, array $attribs, boolean $pre = false ) : Form
$container string
$attribs array
$pre boolean
Результат Form

setField() публичный Метод

Set a single field in $initFieldsValues
public setField ( string $name, array $field ) : Form
$name string
$field array
Результат Form

setFieldValues() публичный Метод

Set the field values. Optionally, you can apply filters to the passed values via callbacks and their parameters
public setFieldValues ( array $values = null, array $filters = null ) : Form
$values array
$filters array
Результат Form

setFields() публичный Метод

Set the fields of the form object.
public setFields ( array $fields ) : Form
$fields array
Результат Form

setMethod() публичный Метод

Set the form method.
public setMethod ( string $method ) : Form
$method string
Результат Form

setTemplate() публичный Метод

Set a form template for the render method to utilize.
public setTemplate ( string $tmpl ) : Form
$tmpl string
Результат Form

Описание свойств

$action защищенное свойство

Form action
protected string $action
Результат string

$errorDisplay защищенное свойство

Global Form error display format
protected array $errorDisplay
Результат array

$fields защищенное свойство

Form field values
protected array $fields
Результат array

$form защищенное свойство

Form element node
protected Child,Pop\Dom $form
Результат Pop\Dom\Child

$groups защищенное свойство

Form field groups
protected array $groups
Результат array

$hasFile защищенное свойство

Has file flag
protected bool $hasFile
Результат boolean

$initFieldsValues защищенное свойство

Form init field values
protected array $initFieldsValues
Результат array

$method защищенное свойство

Form method
protected string $method
Результат string

$template защищенное свойство

Form template for HTML formatting.
protected string $template
Результат string