Form/Decorator/PrepareElements.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Form  
Subpackage
Decorator  

\Zend_Form_Decorator_PrepareElements

Package: Zend\Form\Decorator
Zend_Form_Decorator_PrepareElements

Render all form elements registered with current form

Accepts following options: - separator: Separator to use between elements

Any other options passed will be used as HTML attributes of the form tag.

Parent(s)
\Zend_Form_Decorator_FormElements < \Zend_Form_Decorator_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Version
$Id: PrepareElements.php 24593 2012-01-05 20:35:02Z matthew $  

Constants

Properties

>VPropertyprotectedarray $_options = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Decorator_Abstract::$$_options  
Inherited_from
\Zend_Form_Decorator_FormElements::$$_options  
>VPropertyprotectedstring $_placement = 'APPEND'
Default value'APPEND'Details
Type
string
Inherited_from
\Zend_Form_Decorator_Abstract::$$_placement  
Inherited_from
\Zend_Form_Decorator_FormElements::$$_placement  
>VPropertyprotectedstring $_separator = PHP_EOL
inherited
Separator between new content and old
Inherited from: \Zend_Form_Decorator_Abstract::$$_separator\Zend_Form_Decorator_FormElements::$$_separator
Default valuePHP_EOLDetails
Type
string
Inherited_from
\Zend_Form_Decorator_Abstract::$$_separator  
Inherited_from
\Zend_Form_Decorator_FormElements::$$_separator  

Methods

methodpublic__construct(array | \Zend_Config $options = null) : void

Accept options during initialization.

Parameters
NameTypeDescription
$optionsarray | \Zend_Config
methodprotected_recursivelyPrepareForm( $form) : void

Parameters
NameTypeDescription
$form
methodpublicgetOption(string $key) : mixed
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetOptions() : array
Returns
TypeDescription
array
methodpublicgetPlacement() : string
inherited

Determine if decorator should append or prepend content

Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()\Zend_Form_Decorator_FormElements::getPlacement()
Returns
TypeDescription
string
methodpublicgetSeparator() : string
inherited

Retrieve separator to use between old and new content

Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()\Zend_Form_Decorator_FormElements::getSeparator()
Returns
TypeDescription
string
methodpublicmergeBelongsTo(string $baseBelongsTo, string $belongsTo) : string
inherited

Merges given two belongsTo (array notation) strings

Inherited from: \Zend_Form_Decorator_FormElements::mergeBelongsTo()
Parameters
NameTypeDescription
$baseBelongsTostring
$belongsTostring
Returns
TypeDescription
string
methodpublicremoveOption(mixed $key) : void
Parameters
NameTypeDescription
$keymixed
methodpublicrender(string $content) : string

Render form elements

Parameters
NameTypeDescription
$contentstring
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Form_Decorator_Exceptionwhen unimplemented
methodpublicsetConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract

While the name is "setElement", a form decorator could decorate either an element or a form object.

Parameters
NameTypeDescription
$element\Zend_Form_Element | \Zend_Form
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
Throws
ExceptionDescription
\Zend_Form_Decorator_Exceptionon invalid element type
methodpublicsetOption(string $key, mixed $value) : \Zend_Form_Decorator_Abstract
Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetOptions(array $options) : \Zend_Form_Decorator_Abstract
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
Documentation was generated by phpDocumentor 2.0.0a12.