Form/Decorator/HtmlTag.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  
Subpackage
Decorator  

\Zend_Form_Decorator_HtmlTag

Package: Zend\Form\Decorator
Zend_Form_Decorator_Element_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

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

Properties

>VPropertyprotected\Zend_Form_Element|\Zend_Form $_element
>VPropertyprotectedstring $_encoding
Character encoding to use when escaping attributes
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 = null
Placement; default to surround content
Default valuenullDetails
Type
string
>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 $_tag
HTML tag to use
Details
Type
string
>VPropertyprotected\Zend_Filter $_tagFilter
Details
Type
\Zend_Filter

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
methodprotected_getCloseTag(string $tag) : string

Get formatted closing tag

Parameters
NameTypeDescription
$tagstring
Returns
TypeDescription
string
methodprotected_getEncoding() : string

Get encoding for use with htmlspecialchars()

Returns
TypeDescription
string
methodprotected_getOpenTag(string $tag, array $attribs = null) : string

Get the formatted open tag

Parameters
NameTypeDescription
$tagstring
$attribsarray
Returns
TypeDescription
string
methodprotected_htmlAttribs( $attribs) : string

Convert options to tag attributes

Parameters
NameTypeDescription
$attribs
Returns
TypeDescription
string
methodpublicclearOptions() : \Zend_Form_Decorator_Abstract
inherited

Clear all options

Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicgetElement() : \Zend_Form_Element | \Zend_Form
inherited

Retrieve current element

Inherited from: \Zend_Form_Decorator_Abstract::getElement()
Returns
TypeDescription
\Zend_Form_Element | \Zend_Form
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
methodpublicgetTag() : string

Get tag

If no tag is registered, either via setTag() or as an option, uses 'div'.

Returns
TypeDescription
string
methodpublicnormalizeTag(string $tag) : string

Normalize tag

Ensures tag is alphanumeric characters only, and all lowercase.

Parameters
NameTypeDescription
$tagstring
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 content wrapped in an HTML tag

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
methodpublicsetTag(string $tag) : \Zend_Form_Decorator_HtmlTag

Set tag to use

Parameters
NameTypeDescription
$tagstring
Returns
TypeDescription
\Zend_Form_Decorator_HtmlTag
Documentation was generated by phpDocumentor 2.0.0a12.