API Documentation

Form/Decorator/Interface.php

Interfaces
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Form
Interfaces
Zend_Form_Decorator_Interface

Description

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.

Zend_Form_Decorator_Interface

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Form
subpackage
Decorator
version
$Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
Methods
__construct
setElement
getElement
setOptions
setConfig
setOption
getOption
getOptions
removeOption
clearOptions
render

Description

Zend_Form_Decorator_Interface

Methods

__construct

__construct( array|Zend_Config $options = null ) : void

Constructor

Accept options during initialization.

Arguments
$options
arrayZend_Config
Details
visibility
public
final
false
static
false

clearOptions

clearOptions( ) : Zend_Form_Decorator_Interface

Clear all options

Details
visibility
public
final
false
static
false

getElement

getElement( ) : mixed

Retrieve current element

Output
mixed
Details
visibility
public
final
false
static
false

getOption

getOption( string $key ) : mixed

Retrieve a single option

Arguments
$key
string
Output
mixed
Details
visibility
public
final
false
static
false

getOptions

getOptions( ) : array

Retrieve decorator options

Output
array
Details
visibility
public
final
false
static
false

removeOption

removeOption( string $key ) : bool

Delete a single option

Arguments
$key
string
Output
bool
Details
visibility
public
final
false
static
false

render

render( string $content ) : string

Render the element

Arguments
$content
string
Content to decorate
Output
string
Details
visibility
public
final
false
static
false

setConfig

setConfig( Zend_Config $config ) : Zend_Form_Decorator_Interface

Set decorator options from a config object

Arguments
$config
Zend_Config
Details
visibility
public
final
false
static
false

setElement

setElement( 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.

Arguments
$element
mixed
Details
visibility
public
final
false
static
false

setOption

setOption( string $key, mixed $value ) : Zend_Form_Decorator_Interface

Set a single option

Arguments
$key
string
$value
mixed
Details
visibility
public
final
false
static
false

setOptions

setOptions( array $options ) : Zend_Form_Decorator_Interface

Set decorator options from an array

Arguments
$options
array
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.