Form/Decorator/Fieldset.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_Fieldset
jump to top

Package: Zend\Form\Decorator
Zend_Form_Decorator_Fieldset

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

Parent(s)
\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: Fieldset.php 24961 2012-06-15 14:15:47Z adamlundrigan $  

Constants

>VConstant  APPEND = 'APPEND'
inherited
Placement constants
Inherited from: \Zend_Form_Decorator_Abstract::APPEND
Inherited_from
\Zend_Form_Decorator_Abstract::APPEND  
>VConstant  PREPEND = 'PREPEND'
inheritedInherited from: \Zend_Form_Decorator_Abstract::PREPEND
Inherited_from
\Zend_Form_Decorator_Abstract::PREPEND  

Properties

>VPropertyprotected\Zend_Form_Element|\Zend_Form $_element
inherited
Inherited from: \Zend_Form_Decorator_Abstract::$$_element
Details
Type
\Zend_Form_Element | \Zend_Form
Inherited_from
\Zend_Form_Decorator_Abstract::$$_element  
>VPropertyprotectedstring $_legend
Fieldset legend
Details
Type
string
>VPropertyprotectedarray $_options = array()
inherited
Decorator options
Inherited from: \Zend_Form_Decorator_Abstract::$$_options
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Decorator_Abstract::$$_options  
>VPropertyprotectedstring $_placement = null
Default placement: surround content
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_separator = PHP_EOL
inherited
Separator between new content and old
Inherited from: \Zend_Form_Decorator_Abstract::$$_separator
Default valuePHP_EOLDetails
Type
string
Inherited_from
\Zend_Form_Decorator_Abstract::$$_separator  
>VPropertypublicarray $stripAttribs = array('action', 'enctype', 'helper', 'method', 'name', 'accept-charset')
Attribs that should be removed prior to rendering
Default valuearray('action', 'enctype', 'helper', 'method', 'name', 'accept-charset')Details
Type
array

Methods

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

Constructor

Inherited from: \Zend_Form_Decorator_Abstract::__construct()

Accept options during initialization.

Parameters
NameTypeDescription
$optionsarray | \Zend_Config
methodpublicclearOptions() : \Zend_Form_Decorator_Abstract
inherited

Clear all options

Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicgetElement() : \Zend_Form_Element | \Zend_Form
inherited

Retrieve current element

Inherited from: \Zend_Form_Decorator_Abstract::getElement()
Returns
TypeDescription
\Zend_Form_Element | \Zend_Form
methodpublicgetLegend() : string

Get legend

Returns
TypeDescription
string
methodpublicgetOption(string $key) : mixed
inherited

Get option

Inherited from: \Zend_Form_Decorator_Abstract::getOption()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetOptions() : array

Get options

Merges in element attributes as well.

Returns
TypeDescription
array
methodpublicgetPlacement() : string
inherited

Determine if decorator should append or prepend content

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

Retrieve separator to use between old and new content

Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()
Returns
TypeDescription
string
methodpublicremoveOption(mixed $key) : void
inherited

Remove single option

Inherited from: \Zend_Form_Decorator_Abstract::removeOption()
Parameters
NameTypeDescription
$keymixed
methodpublicrender(string $content) : string

Render a fieldset

Parameters
NameTypeDescription
$contentstring
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Form_Decorator_Exceptionwhen unimplemented
methodpublicsetConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract
inherited

Set options from config object

Inherited from: \Zend_Form_Decorator_Abstract::setConfig()
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract
inherited

Set current form element

Inherited from: \Zend_Form_Decorator_Abstract::setElement()

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
methodpublicsetLegend(string $value) : \Zend_Form_Decorator_Fieldset

Set legend

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Form_Decorator_Fieldset
methodpublicsetOption(string $key, mixed $value) : \Zend_Form_Decorator_Abstract
inherited

Set option

Inherited from: \Zend_Form_Decorator_Abstract::setOption()
Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetOptions(array $options) : \Zend_Form_Decorator_Abstract
inherited

Set options

Inherited from: \Zend_Form_Decorator_Abstract::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
Documentation was generated by phpDocumentor 2.0.0a12.