Form/Decorator/Abstract.php

Show:

inherited

Classes
- \Zend_Form_Decorator_Abstract

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
jump to top

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
Version: $Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $

Constants

 
                APPEND
                = 'APPEND'

Placement constants

 
                PREPEND
                = 'PREPEND'

Properties

\Zend_Form_Element|\Zend_Form $_element

Details

Type: \Zend_Form_Element | \Zend_Form

array $_options = array()

Decorator options

Default valuearray()Details

Type: array

string $_placement = 'APPEND'

Default placement: append

Default value'APPEND'Details

Type: string

string $_separator = PHP_EOL

Separator between new content and old

Default valuePHP_EOLDetails

Type: string

Methods

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

Constructor

Accept options during initialization.

Parameters

Name	Type	Description
$options	array \| \Zend_Config

clearOptions() : \Zend_Form_Decorator_Abstract

Clear all options

Returns

Type	Description
\Zend_Form_Decorator_Abstract

getElement() : \Zend_Form_Element | \Zend_Form

Retrieve current element

Returns

Type	Description
\Zend_Form_Element \| \Zend_Form

getOption(string $key) : mixed

Get option

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getOptions() : array

Retrieve options

Returns

Type	Description
array

getPlacement() : string

Determine if decorator should append or prepend content

Returns

Type	Description
string

getSeparator() : string

Retrieve separator to use between old and new content

Returns

Type	Description
string

removeOption(mixed $key) : void

Remove single option

Parameters

Name	Type	Description
$key	mixed

render(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

setConfig(\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

setElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract

Set current form element

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

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

setOption(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

setOptions(array $options) : \Zend_Form_Decorator_Abstract

Set options

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Form_Decorator_Abstract

Form/Decorator/Abstract.php

\Zend_Form_Decorator_Abstractjump to top

Constants

Properties

Methods

\Zend_Form_Decorator_Abstract
jump to top