Form/Decorator/File.php
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
- Subpackage
- Decorator
\Zend_Form_Decorator_File
Package: Zend\Form\Decorator




Parameters




Parameters
Returns
Throws


Zend_Form_Decorator_File
Fixes the rendering for all subform and multi file elements
- Implements
- \Zend_Form_Decorator_Marker_File_Interface
- Parent(s)
- \Zend_Form_Decorator_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id: File.php 25067 2012-11-03 14:20:28Z rob $
Constants

PREPEND
= 'PREPEND'
inheritedInherited from:
\Zend_Form_Decorator_Abstract::PREPEND
- Inherited_from
- \Zend_Form_Decorator_Abstract::PREPEND
Properties


array $_attribBlacklist = array('helper', 'placement', 'separator', 'value')
Attributes that should not be passed to helper
Default value
array('helper', 'placement', 'separator', 'value')
Details- Type
- array


\Zend_Form_Element|\Zend_Form $_element
inheritedInherited from:
\Zend_Form_Decorator_Abstract::$$_element
Details
- Type
- \Zend_Form_Element | \Zend_Form
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_element


array $_options = array()
Default value
array()
Details- Type
- array
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_options


string $_separator = PHP_EOL
inherited
Separator between new content and old
Inherited from:
\Zend_Form_Decorator_Abstract::$$_separatorDefault value
PHP_EOL
Details- Type
- string
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_separator
Methods


__construct(array | \Zend_Config $options = null) : void
Accept options during initialization.
Name | Type | Description |
---|---|---|
$options | array | \Zend_Config |


getPlacement() : string
inherited
Determine if decorator should append or prepend content
Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()Returns
Type | Description |
---|---|
string |


getSeparator() : string
inherited
Retrieve separator to use between old and new content
Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()Returns
Type | Description |
---|---|
string |


render(string $content) : string
Render a form file
Parameters
Returns
Throws
Name | Type | Description |
---|---|---|
$content | string |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Form_Decorator_Exception | when unimplemented |


setConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract
Parameters
Returns
Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |


setElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract
While the name is "setElement", a form decorator could decorate either an element or a form object.
Name | Type | Description |
---|---|---|
$element | \Zend_Form_Element | \Zend_Form |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |
Exception | Description |
---|---|
\Zend_Form_Decorator_Exception | on invalid element type |


setOption(string $key, mixed $value) : \Zend_Form_Decorator_Abstract
Parameters
Returns
Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |


setOptions(array $options) : \Zend_Form_Decorator_Abstract
Parameters
Returns
Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |