Dojo/Form/Decorator/DijitContainer.php

Show: PublicProtectedPrivateinherited
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_Dojo_Form_Decorator_DijitContainer

Package: Zend\Dojo\Form\Decorator
Zend_Dojo_Form_Decorator_DijitContainer

Render a dojo dijit layout container via a view helper

Accepts the following options: - helper: the name of the view helper to use

Assumes the view helper accepts four parameters, the id, content, dijit parameters, and (X)HTML attributes; these will be provided by the element.

Parent(s)
\Zend_Form_Decorator_Abstract
Children
\Zend_Dojo_Form_Decorator_ContentPane
\Zend_Dojo_Form_Decorator_SplitContainer
\Zend_Dojo_Form_Decorator_TabContainer
\Zend_Dojo_Form_Decorator_AccordionContainer
\Zend_Dojo_Form_Decorator_DijitForm
\Zend_Dojo_Form_Decorator_BorderContainer
\Zend_Dojo_Form_Decorator_StackContainer
\Zend_Dojo_Form_Decorator_AccordionPane
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\global\Zend_Form_Decorator_Abstract  
Version
$Id: DijitContainer.php 24593 2012-01-05 20:35:02Z matthew $  

Constants

>VConstant  APPEND = 'APPEND'
inherited
Placement constants
Inherited from: \Zend_Form_Decorator_Abstract::APPEND
>VConstant  PREPEND = 'PREPEND'

Properties

>VPropertyprotectedarray $_attribs
Element attributes
Details
Type
array
>VPropertyprotectedarray $_dijitParams
Dijit option parameters
Details
Type
array
>VPropertyprotected\Zend_Form_Element|\Zend_Form $_element
>VPropertyprotectedstring $_helper
View helper
Details
Type
string
>VPropertyprotectedarray $_options = array()
inherited
Decorator options
Inherited from: \Zend_Form_Decorator_Abstract::$$_options
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Decorator_Abstract::$$_options  
>VPropertyprotectedstring $_placement = 'APPEND'
inherited
Default placement: append
Inherited from: \Zend_Form_Decorator_Abstract::$$_placement
Default value'APPEND'Details
Type
string
Inherited_from
\Zend_Form_Decorator_Abstract::$$_placement  
>VPropertyprotectedstring $_separator = PHP_EOL
inherited
Separator between new content and old
Inherited from: \Zend_Form_Decorator_Abstract::$$_separator
Default valuePHP_EOLDetails
Type
string
Inherited_from
\Zend_Form_Decorator_Abstract::$$_separator  
>VPropertyprotectedstring $_title
Container title
Details
Type
string

Methods

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

Constructor

Inherited from: \Zend_Form_Decorator_Abstract::__construct()

Accept options during initialization.

Parameters
NameTypeDescription
$optionsarray | \Zend_Config
methodpublicclearOptions() : \Zend_Form_Decorator_Abstract
inherited

Clear all options

Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicgetAttribs() : array

Get element attributes

Returns
TypeDescription
array
methodpublicgetDijitParams() : array

Get dijit option parameters

Returns
TypeDescription
array
methodpublicgetElement() : \Zend_Form_Element | \Zend_Form
inherited

Retrieve current element

Inherited from: \Zend_Form_Decorator_Abstract::getElement()
Returns
TypeDescription
\Zend_Form_Element | \Zend_Form
methodpublicgetHelper() : string

Get view helper for rendering container

Returns
TypeDescription
string
methodpublicgetOption(string $key) : mixed
inherited

Get option

Inherited from: \Zend_Form_Decorator_Abstract::getOption()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetOptions() : array
inherited

Retrieve options

Inherited from: \Zend_Form_Decorator_Abstract::getOptions()
Returns
TypeDescription
array
methodpublicgetPlacement() : string
inherited

Determine if decorator should append or prepend content

Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()
Returns
TypeDescription
string
methodpublicgetSeparator() : string
inherited

Retrieve separator to use between old and new content

Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()
Returns
TypeDescription
string
methodpublicgetTitle() : string

Get title

Returns
TypeDescription
string
methodpublicremoveOption(mixed $key) : void
inherited

Remove single option

Inherited from: \Zend_Form_Decorator_Abstract::removeOption()
Parameters
NameTypeDescription
$keymixed
methodpublicrender(string $content) : string

Render a dijit layout container

Replaces $content entirely from currently set element.

Parameters
NameTypeDescription
$contentstring
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Form_Decorator_Exceptionwhen unimplemented
methodpublicsetConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract
inherited

Set options from config object

Inherited from: \Zend_Form_Decorator_Abstract::setConfig()
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract
inherited

Set current form element

Inherited from: \Zend_Form_Decorator_Abstract::setElement()

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

Parameters
NameTypeDescription
$element\Zend_Form_Element | \Zend_Form
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
Throws
ExceptionDescription
\Zend_Form_Decorator_Exceptionon invalid element type
methodpublicsetOption(string $key, mixed $value) : \Zend_Form_Decorator_Abstract
inherited

Set option

Inherited from: \Zend_Form_Decorator_Abstract::setOption()
Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetOptions(array $options) : \Zend_Form_Decorator_Abstract
inherited

Set options

Inherited from: \Zend_Form_Decorator_Abstract::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
Documentation was generated by phpDocumentor 2.0.0a12.