API Documentation

Form/Decorator/Abstract.php

Includes Classes 
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
Classes
Zend_Form_Decorator_Abstract

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_Abstract

Implements
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: Abstract.php 21147 2010-02-23 14:42:04Z yoshida@zend.co.jp $
Constants
APPEND
PREPEND
Properties
$_placement
$_element
$_options
$_separator
Methods
__construct
setOptions
setConfig
setOption
getOption
getOptions
removeOption
clearOptions
setElement
getElement
getPlacement
getSeparator
render

Description

Zend_Form_Decorator_Abstract

Constants

APPEND

 APPEND = 'APPEND'

Placement constants

Details

value
APPEND

PREPEND

 PREPEND = 'PREPEND'

Details

value
PREPEND

Properties

$_element

Zend_Form_Element|Zend_Form $_element = ''

Details

$_element
Zend_Form_Element|Zend_Form
visibility
protected
default
final
false
static
false

$_options

array $_options = 'array'

Decorator options

Details

$_options
array
visibility
protected
default
array
final
false
static
false

$_placement

string $_placement = 'APPEND'

Default placement: append

Details

$_placement
string
visibility
protected
default
APPEND
final
false
static
false

$_separator

string $_separator = 'PHP_EOL'

Separator between new content and old

Details

$_separator
string
visibility
protected
default
PHP_EOL
final
false
static
false

Methods

__construct

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

Constructor

Arguments
$options
arrayZend_Config
Details
visibility
public
final
false
static
false

clearOptions

clearOptions( ) : Zend_Form_Decorator_Abstract

Clear all options

Details
visibility
public
final
false
static
false

getElement

getElement( ) : Zend_Form_Element|Zend_Form

Retrieve current element

Details
visibility
public
final
false
static
false

getOption

getOption( string $key ) : mixed

Get option

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

getOptions

getOptions( ) : array

Retrieve options

Output
array
Details
visibility
public
final
false
static
false

getPlacement

getPlacement( ) : string

Determine if decorator should append or prepend content

Output
string
Details
visibility
public
final
false
static
false

getSeparator

getSeparator( ) : string

Retrieve separator to use between old and new content

Output
string
Details
visibility
public
final
false
static
false

removeOption

removeOption( mixed $key ) : void

Remove single option

Arguments
$key
mixed
Details
visibility
public
final
false
static
false

render

render( string $content ) : string

Decorate content and/or element

Arguments
$content
string
Output
string
Details
visibility
public
final
false
static
false
throws
when unimplemented

setConfig

setConfig( Zend_Config $config ) : Zend_Form_Decorator_Abstract

Set options from config object

Arguments
$config
Zend_Config
Details
visibility
public
final
false
static
false

setElement

setElement( Zend_Form_Element|Zend_Form $element ) : Zend_Form_Decorator_Abstract

Set current form element

Arguments
$element
Zend_Form_ElementZend_Form
Details
visibility
public
final
false
static
false
throws
on invalid element type

setOption

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

Set option

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

setOptions

setOptions( array $options ) : Zend_Form_Decorator_Abstract

Set options

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