API Documentation

Zend/Form/Decorator/Abstract.php

Show: inherited
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  

\Zend_Form_Decorator_Abstract

Package: Zend\Form\Decorator

Zend_Form_Decorator_Abstract

Implements
\Zend_Form_Decorator_Interface
Children
\Zend_Dojo_Form_Decorator_DijitContainer
\Zend_Form_Decorator_Errors
\Zend_Form_Decorator_Fieldset
\Zend_Form_Decorator_ViewHelper
\Zend_Form_Decorator_FormErrors
\Zend_Form_Decorator_Callback
\Zend_Form_Decorator_Form
\Zend_Form_Decorator_Tooltip
\Zend_Form_Decorator_Label
\Zend_Form_Decorator_File
\Zend_Form_Decorator_Captcha_ReCaptcha
\Zend_Form_Decorator_Captcha_Word
\Zend_Form_Decorator_Image
\Zend_Form_Decorator_Captcha
\Zend_Form_Decorator_Description
\Zend_Form_Decorator_FormElements
\Zend_Form_Decorator_ViewScript
\Zend_Form_Decorator_DtDdWrapper
\Zend_Form_Decorator_HtmlTag
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Used_by
\Zend_Dojo_Form_Decorator_DijitContainer  
Version
$Id: Abstract.php 24594 2012-01-05 21:27:01Z matthew $  

Constants

Constant  APPEND = 'APPEND'

Placement constants

Constant  PREPEND = 'PREPEND'

Properties

Propertyprotected\Zend_Form_Element|\Zend_Form  $_element= ''

Propertyprotectedarray  $_options= 'array()'

Decorator options

Default valuearray()Details
Type
array
Propertyprotectedstring  $_placement= ''APPEND''

Default placement: append

Default value'APPEND'Details
Type
string
Propertyprotectedstring  $_separator= 'PHP_EOL'

Separator between new content and old

Default valuePHP_EOLDetails
Type
string

Methods

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

Constructor

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

Clear all options

Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicgetElement( ) : \Zend_Form_Element|\Zend_Form

Retrieve current element

Returns
Type Description
\Zend_Form_Element|\Zend_Form
methodpublicgetOption( string $key ) : mixed

Get option

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

Retrieve options

Returns
Type Description
array
methodpublicgetPlacement( ) : string

Determine if decorator should append or prepend content

Returns
Type Description
string
methodpublicgetSeparator( ) : string

Retrieve separator to use between old and new content

Returns
Type Description
string
methodpublicremoveOption( mixed $key ) : void

Remove single option

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

Decorate content and/or element

Parameters
Name Type Description
$content string
Returns
Type Description
string
Throws
Exception Description
\Zend_Form_Decorator_Exception when unimplemented
methodpublicsetConfig( \Zend_Config $config ) : \Zend_Form_Decorator_Abstract

Set options from config object

Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicsetElement( \Zend_Form_Element|\Zend_Form $element ) : \Zend_Form_Decorator_Abstract

Set current form element

Parameters
Name Type Description
$element \Zend_Form_Element|\Zend_Form
Returns
Type Description
\Zend_Form_Decorator_Abstract
Throws
Exception Description
\Zend_Form_Decorator_Exception on invalid element type
methodpublicsetOption( string $key, mixed $value ) : \Zend_Form_Decorator_Abstract

Set option

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

Set options

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Form_Decorator_Abstract
Documentation was generated by DocBlox 0.15.1.