API Documentation

Form/Decorator/Interface.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Form  

\Zend_Form_Decorator_Interface

Zend_Form_Decorator_Interface

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Form  
subpackage
Decorator  
version
$Id: Interface.php 23775 2011-03-01 17:25:24Z ralph $  

Methods

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

Constructor

Accept options during initialization.

Parameters
Name Type Description
$options array|\Zend_Config
methodpublicclearOptions( ) : \Zend_Form_Decorator_Interface

Clear all options

Returns
Type Description
\Zend_Form_Decorator_Interface
methodpublicgetElement( ) : mixed

Retrieve current element

Returns
Type Description
mixed
methodpublicgetOption( string $key ) : mixed

Retrieve a single option

Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublicgetOptions( ) : array

Retrieve decorator options

Returns
Type Description
array
methodpublicremoveOption( string $key ) : bool

Delete a single option

Parameters
Name Type Description
$key string
Returns
Type Description
bool
methodpublicrender( string $content ) : string

Render the element

Parameters
Name Type Description
$content string Content to decorate
Returns
Type Description
string
methodpublicsetConfig( \Zend_Config $config ) : \Zend_Form_Decorator_Interface

Set decorator options from a config object

Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Form_Decorator_Interface
methodpublicsetElement( mixed $element ) : \Zend_Form_Decorator_Interface

Set an element to decorate

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

Parameters
Name Type Description
$element mixed
Returns
Type Description
\Zend_Form_Decorator_Interface
methodpublicsetOption( string $key, mixed $value ) : \Zend_Form_Decorator_Interface

Set a single option

Parameters
Name Type Description
$key string
$value mixed
Returns
Type Description
\Zend_Form_Decorator_Interface
methodpublicsetOptions( array $options ) : \Zend_Form_Decorator_Interface

Set decorator options from an array

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Form_Decorator_Interface
Documentation was generated by DocBlox 0.13.3.