Zend_Form_SubForm
| category | Zend |
|---|---|
| package | Zend_Form |
| copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license | New BSD License |
| version | $Id$ |
| inherited_from | \Zend_Form |
__call(string $method, array $args) : string
Call renderDecoratorName() to render a specific decorator.
string
array
\Zend_Form_Exception |
for invalid decorator or invalid method call |
|---|
string__clone() : void
__construct(mixed $options = null)
Registers form view helper as decorator
mixed
__get(string $name) : \Zend_Form_Element | \Zend_Form | null
string
\Zend_Form_Element\Zend_Formnull
__isset(string $name) : boolean
string
boolean__set(string $name, \Zend_Form_Element|\Zend_Form $value) : void
string
\Zend_Form_Element\Zend_Form
\Zend_Form_Exception |
for invalid $value |
|---|
__toString() : string
Proxies to \render().
string__unset(string $name) : void
string
addAttribs(array $attribs) : \Zend_Form
array
\Zend_FormaddDecorator(string|\Zend_Form_Decorator_Interface $decorator, array|\Zend_Config $options = null) : \Zend_Form
string\Zend_Form_Decorator_Interface
array\Zend_ConfigOptions with which to initialize decorator
\Zend_Form_Exception |
|---|
\Zend_FormaddDecorators(array $decorators) : \Zend_Form
array
\Zend_Form_Exception |
|---|
\Zend_FormaddDisplayGroup(array $elements, string $name, array|\Zend_Config $options = null) : \Zend_Form
Groups named elements for display purposes.
If a referenced element does not yet exist in the form, it is omitted.
array
string
array\Zend_Config
\Zend_Form_Exception |
if no valid elements provided |
|---|
\Zend_FormaddDisplayGroupPrefixPath(string $prefix, string $path) : \Zend_Form
string
string
\Zend_FormaddDisplayGroupPrefixPaths(array $spec) : \Zend_Form
array
\Zend_FormaddDisplayGroups(array $groups) : \Zend_Form
array
\Zend_FormaddElement(string|\Zend_Form_Element $element, string $name= null, array|\Zend_Config $options= null) : \Zend_Form
$element may be either a string element type, or an object of type Zend_Form_Element. If a string element type is provided, $name must be provided, and $options may be optionally provided for configuring the element.
If a Zend_Form_Element is provided, $name may be optionally provided, and any provided $options will be ignored.
string\Zend_Form_Element
string
array\Zend_Config
\Zend_Form_Exception |
on invalid element |
|---|
\Zend_FormaddElementPrefixPath(string $prefix, string $path, string $type = null) : \Zend_Form
string
string
string
\Zend_FormaddElementPrefixPaths(array $spec) : \Zend_Form
array
\Zend_FormaddElements(array $elements) : \Zend_Form
array
\Zend_FormaddError(string $message) : \Zend_Form
string
\Zend_FormaddErrorMessage(string $message) : \Zend_Form
string
\Zend_FormaddErrorMessages(array $messages) : \Zend_Form
array
\Zend_FormaddErrors(array $messages) : \Zend_Form
array
\Zend_FormaddPrefixPath(string $prefix, string $path, string $type = null) : \Zend_Form
If no $type specified, assumes it is a base path for both filters and validators, and sets each according to the following rules:
Otherwise, the path prefix is set on the appropriate plugin loader.
If $type is 'decorator', sets the path in the decorator plugin loader for all elements. Additionally, if no $type is provided, the prefix and path is added to both decorator and element plugin loader with following settings: $prefix . '_Decorator', $path . '/Decorator/' $prefix . '_Element', $path . '/Element/'
string
string
string
\Zend_Form_Exception |
for invalid type |
|---|
\Zend_FormaddPrefixPaths(array $spec) : \Zend_Form
array
\Zend_FormaddSubForm(\Zend_Form $form, string $name, integer $order = null) : \Zend_Form
\Zend_Form
string
integer
\Zend_FormaddSubForms(array $subForms) : \Zend_Form
array
\Zend_FormclearAttribs() : \Zend_Form
\Zend_FormclearDecorators() : \Zend_Form
\Zend_FormclearDisplayGroups() : \Zend_Form
\Zend_FormclearElements() : \Zend_Form
\Zend_FormclearErrorMessages() : \Zend_Form
\Zend_FormclearSubForms() : \Zend_Form
\Zend_Formcount() : integer
integercreateElement(string $type, string $name, array|\Zend_Config $options = null) : \Zend_Form_Element
Acts as a factory for creating elements. Elements created with this method will not be attached to the form, but will contain element settings as specified in the form object (including plugin loader prefix paths, default decorators, etc.).
string
string
array\Zend_Config
\Zend_Form_Exception |
|---|
\Zend_Form_Elementcurrent() : \Zend_Form_Element | \Zend_Form_DisplayGroup | \Zend_Form
\Zend_Form_Exception |
|---|
\Zend_Form_Element\Zend_Form_DisplayGroup\Zend_Form
filterName(string $value, boolean $allowBrackets = false) : string
string
boolean
stringgetAction() : string
Sets default to '' if not set.
stringgetAttrib(string $key) : mixed
string
mixedgetAttribs() : array
arraygetCustomMessages() : array
arraygetDecorator(string $name) : false | \Zend_Form_Decorator_Abstract
string
false\Zend_Form_Decorator_Abstract
getDecorators() : array
arraygetDefaultDisplayGroupClass() : string
stringgetDefaultTranslator() : null | \Zend_Translate
null\Zend_Translate
getDescription() : string
stringgetDisplayGroup(string $name) : \Zend_Form_DisplayGroup | null
string
\Zend_Form_DisplayGroupnull
getDisplayGroups() : array
arraygetElement(string $name) : \Zend_Form_Element | null
string
\Zend_Form_Elementnull
getElements() : array
arraygetElementsAndSubFormsOrdered() : array
Subitems are inserted based on their order Setting if set, otherwise they are appended, the resulting numerical index may differ from the order value.
| access | protected |
|---|
arraygetElementsBelongTo() : string | null
stringnull
getEnctype() : string
stringgetErrorMessages() : array
arraygetErrors(string $name= null, boolean $suppressArrayNotation= false) : array
string
boolean
arraygetFullyQualifiedName() : string
Places name as subitem of array and/or appends brackets.
stringgetId() : string
stringgetLegend() : string
stringgetMessages(string $name= null, boolean $suppressArrayNotation= false) : array
If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.
| inherited_from | \Zend_Validate_Interface::getMessages() |
|---|
string
boolean
arraygetMethod() : string
stringgetName() : null | string
nullstring
getOrder() : integer | null
integernull
getPluginLoader(string $type = null) : \Zend_Loader_PluginLoader_Interface
$type may be one of:
If a plugin loader does not exist for the given type, defaults are created.
string
\Zend_Form_Exception |
|---|
\Zend_Loader_PluginLoader_InterfacegetSubForm(string $name) : \Zend_Form | null
string
\Zend_Formnull
getSubForms() : array
arraygetTranslator() : \Zend_Translate | null
\Zend_Translatenull
getUnfilteredValue(string $name) : mixed
string
mixedgetUnfilteredValues() : array
arraygetValidValues(array $data, boolean $suppressArrayNotation = false) : array
For models that can be saved in a partially valid state, for example when following the builder, prototype or state patterns it is particularly interessting to retrieve all the current valid values to persist them.
array
boolean
arraygetValue(string $name) : mixed
string
mixedgetValues(boolean $suppressArrayNotation = false) : array
boolean
arraygetView() : \Zend_View_Interface | null
If none registered, attempts to pull from ViewRenderer.
\Zend_View_Interfacenull
hasDefaultTranslator() : boolean
booleanhasErrors() : boolean
booleanhasTranslator() : boolean
booleaninit() : void
isArray() : boolean
booleanisErrors() : boolean
| deprecated | since 1.11.1 - use hasErrors() instead |
|---|
booleanisValid(array $data) : boolean
If $value fails validation, then this method returns false, and getMessages() will return an array of messages that explain why the validation failed.
| inherited_from | \Zend_Validate_Interface::isValid() |
|---|
array
\Zend_Form_Exception |
|---|
booleanisValidPartial(array $data) : boolean
Does not check for required flags.
array
booleankey() : string
stringloadDefaultDecorators() : \Zend_Form_SubForm
| inherited_from | \Zend_Form::loadDefaultDecorators() |
|---|
\Zend_Form_SubFormloadDefaultDecorators() : \Zend_Form
\Zend_FormloadDefaultDecoratorsIsDisabled() : boolean
booleanmarkAsError() : \Zend_Form
\Zend_Formnext() : void
persistData()
populate(array $values) : \Zend_Form
Proxies to \setDefaults()
array
\Zend_FormprocessAjax(array $data) : string
Checks if provided $data is valid, via \isValidPartial(). If so, it returns JSON-encoded boolean true. If not, it returns JSON-encoded error messages (as returned by \getMessages()).
array
stringJSON-encoded boolean true or error messagesremoveAttrib(string $key) : boolean
string
booleanremoveDecorator(string $name) : boolean
string
booleanremoveDisplayGroup(string $name) : boolean
string
booleanremoveElement(string $name) : boolean
string
booleanremoveFromIteration(string $name) : void
stringElement/group/form name
removeSubForm(string $name) : boolean
string
booleanrender(\Zend_View_Interface $view = null) : string
\Zend_View_Interface
stringreset() : \Zend_Form
\Zend_Formrewind() : void
setAction(string $action) : \Zend_Form
string
\Zend_FormsetAttrib(string $key, mixed $value) : \Zend_Form
string
mixed
\Zend_FormsetAttribs(array $attribs) : \Zend_Form
Overwrites any previously set attributes.
array
\Zend_FormsetConfig(\Zend_Config $config) : \Zend_Form
\Zend_Config
\Zend_FormsetDecorators(array $decorators) : \Zend_Form
array
\Zend_FormsetDefault(string $name, mixed $value) : \Zend_Form
string
mixed
\Zend_FormsetDefaultDisplayGroupClass(string $class) : \Zend_Form
string
\Zend_FormsetDefaultTranslator(\Zend_Translate|\Zend_Translate_Adapter|null $translator = null) : void
\Zend_Translate\Zend_Translate_Adapternull
\Zend_Form_Exception |
|---|
setDefaults(array $defaults) : \Zend_Form
Sets values for all elements specified in the array of $defaults.
array
\Zend_FormsetDescription(string $value) : \Zend_Form
string
\Zend_FormsetDisableLoadDefaultDecorators(boolean $flag) : \Zend_Form
boolean
\Zend_FormsetDisableTranslator(boolean $flag) : \Zend_Form
boolean
\Zend_FormsetDisplayGroupDecorators(array $decorators) : \Zend_Form
array
\Zend_FormsetDisplayGroups(array $groups) : \Zend_Form
array
\Zend_FormsetElementDecorators(array $decorators, array|null $elements= null, boolean $include= true) : \Zend_Form
array
arraynullSpecific elements to decorate or exclude from decoration
booleanWhether $elements is an inclusion or exclusion list
\Zend_FormsetElementFilters(array $filters) : \Zend_Form
array
\Zend_FormsetElements(array $elements) : \Zend_Form
array
\Zend_FormsetElementsBelongTo(string $array) : \Zend_Form
string
\Zend_FormsetEnctype(string $value) : \Zend_Form
string
\Zend_FormsetErrorMessages(array $messages) : \Zend_Form
array
\Zend_FormsetErrors(array $messages) : \Zend_Form
array
\Zend_FormsetIsArray(boolean $flag) : \Zend_Form
booleanValue of flag
\Zend_FormsetLegend(string $value) : \Zend_Form
string
\Zend_FormsetMethod(string $method) : \Zend_Form
Only values in \$_methods() allowed
string
\Zend_Form_Exception |
|---|
\Zend_FormsetName(string $name) : \Zend_Form
string
\Zend_Form_Exception |
|---|
\Zend_FormsetOptions(array $options) : \Zend_Form
array
\Zend_FormsetOrder(integer $index) : \Zend_Form
integer
\Zend_FormsetPluginLoader(\Zend_Loader_PluginLoader_Interface $loader, string $type = null) : \Zend_Form
\Zend_Loader_PluginLoader_Interface
string'decorator' or 'element'
\Zend_Form_Exception |
on invalid type |
|---|
\Zend_FormsetSubFormDecorators(array $decorators) : \Zend_Form
array
\Zend_FormsetSubForms(array $subForms) : \Zend_Form
array
\Zend_FormsetTranslator(\Zend_Translate|\Zend_Translate_Adapter|null $translator = null) : \Zend_Form
\Zend_Translate\Zend_Translate_Adapternull
\Zend_Form_Exception |
|---|
\Zend_FormsetView(\Zend_View_Interface $view = null) : \Zend_Form
\Zend_View_Interface
\Zend_FormtranslatorIsDisabled() : boolean
booleanvalid() : boolean
boolean_addDisplayGroupObject(\Zend_Form_DisplayGroup $group, string|null $name = null) : \Zend_Form
\Zend_Form_DisplayGroup
stringnull
\Zend_Form_Exception |
|---|
\Zend_Form_array_replace_recursive(array $into) : array
array
array_attachToArray(mixed $value, string $arrayPath) : array
mixedThe value to attach
stringGiven array path to convert and attach to.
array_dissolveArrayUnsetKey(array $array, string|null $arrayPath, string $key) : array
array
stringnull
string
array_dissolveArrayValue(array $value, string $arrayPath) : string
Given an array path such as foo[bar][baz], returns the value of the last element (in this case, 'baz').
arrayArray to walk
stringArray notation path of the part to extract
string_getArrayName(string $value) : string
Given a value such as foo[bar][baz], returns the last element (in this case, 'baz').
string
string_getDecorator(string $name, null|array $options) : \Zend_Form_Decorator_Interface
string
nullarray
\Zend_Form_Decorator_Interface_getErrorMessages() : array
array_getIsRendered()
_loadDecorator(array $decorator, mixed $name) : \Zend_Form_Decorator_Interface
arrayDecorator type and options
mixedDecorator name or alias
\Zend_Form_Decorator_Interface_setElementsBelongTo(string $name = null) : void
stringElement name
_setIsRendered()
_sort() : void
\Zend_Form_Exception |
|---|
$_attribs : array
array()$_decorators : array
array()$_defaultDisplayGroupClass : string
'Zend_Form_DisplayGroup'$_description : string
$_disableLoadDefaultDecorators : boolean
false$_displayGroupPrefixPaths : array
array()$_displayGroups : array
array()$_elementDecorators : null | array
$_elementPrefixPaths : array
array()$_elements : array
array()$_elementsBelongTo : string
$_errorMessages : array
array()$_errorsExist : boolean
false$_errorsForced : boolean
false$_formOrder : integer | null
$_isArray : boolean
true| inherited_from | \Zend_Form::_isArray |
|---|
$_isArray : boolean
false$_isRendered : boolean
false$_legend : string
$_loaders : array
array()$_methods : array
array('delete', 'get', 'post', 'put')$_order : array
array()$_orderUpdated : boolean
false$_subFormPrefixPaths : array
array()$_subForms : array
array()$_translator : \Zend_Translate
$_translatorDefault : \Zend_Translate
$_translatorDisabled : boolean
false$_view : \Zend_View_Interface
DECORATOR = 'DECORATOR'
ELEMENT = 'ELEMENT'
ENCTYPE_MULTIPART = 'multipart/form-data'
ENCTYPE_URLENCODED = 'application/x-www-form-urlencoded'
METHOD_DELETE = 'delete'
METHOD_GET = 'get'
METHOD_POST = 'post'
METHOD_PUT = 'put'