Form/Decorator/HtmlTag.php
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_HtmlTag
Wraps content in an HTML block tag.
Options accepted are: - tag: tag to use in decorator - noAttribs: do not render attributes in the opening tag - placement: 'append' or 'prepend'. If 'append', renders opening and closing tag after content; if prepend, renders opening and closing tag before content. - openOnly: render opening tag only - closeOnly: render closing tag only
Any other options passed are processed as HTML attributes of the tag.
- 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: HtmlTag.php 24593 2012-01-05 20:35:02Z matthew $
Constants

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


\Zend_Form_Element|\Zend_Form $_element
- Type
- \Zend_Form_Element | \Zend_Form
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_element


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


string $_separator = PHP_EOL
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 |


_getCloseTag(string $tag) : string
Get formatted closing tag
Name | Type | Description |
---|---|---|
$tag | string |
Type | Description |
---|---|
string |


_getOpenTag(string $tag, array $attribs = null) : string
Get the formatted open tag
Name | Type | Description |
---|---|---|
$tag | string | |
$attribs | array |
Type | Description |
---|---|
string |


_htmlAttribs( $attribs) : string
Convert options to tag attributes
Name | Type | Description |
---|---|---|
$attribs |
Type | Description |
---|---|
string |


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


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


getTag() : string
Get tag
If no tag is registered, either via setTag() or as an option, uses 'div'.
Type | Description |
---|---|
string |


normalizeTag(string $tag) : string
Normalize tag
Ensures tag is alphanumeric characters only, and all lowercase.
Name | Type | Description |
---|---|---|
$tag | string |
Type | Description |
---|---|
string |


render(string $content) : string
Render content wrapped in an HTML tag
Name | Type | Description |
---|---|---|
$content | string |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Form_Decorator_Exception | when unimplemented |


setConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract
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
Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |


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


setTag(string $tag) : \Zend_Form_Decorator_HtmlTag
Set tag to use
Name | Type | Description |
---|---|---|
$tag | string |
Type | Description |
---|---|
\Zend_Form_Decorator_HtmlTag |