API Documentation

Form/Decorator/HtmlTag.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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Form  
subpackage
Decorator  

\Zend_Form_Decorator_HtmlTag

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.

Extends from
\Zend_Form_Decorator_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Form  
subpackage
Decorator  
version
$Id: HtmlTag.php 24428 2011-09-02 14:10:03Z matthew $  

Properties

Propertyprotectedstring  $_encoding= ''

Character encoding to use when escaping attributes

Details
Type
string
Propertyprotectedstring  $_placement= 'null'

Placement; default to surround content

Default valuenullDetails
Type
string
Propertyprotectedstring  $_tag= ''

HTML tag to use

Details
Type
string
Propertyprotected\Zend_Filter  $_tagFilter= ''

Details
Type
\Zend_Filter

Methods

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

Constructor

Inherited from: \Zend_Form_Decorator_Abstract::__construct()

Accept options during initialization.

Parameters
Name Type Description
$options array|\Zend_Config
methodprotected_getCloseTag( string $tag ) : string

Get formatted closing tag

Parameters
Name Type Description
$tag string
Returns
Type Description
string
methodprotected_getEncoding( ) : string

Get encoding for use with htmlspecialchars()

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

Get the formatted open tag

Parameters
Name Type Description
$tag string
$attribs array
Returns
Type Description
string
methodprotected_htmlAttribs(  $attribs ) : string

Convert options to tag attributes

Parameters
Name Type Description
$attribs
Returns
Type Description
string
methodpublicclearOptions( ) : \Zend_Form_Decorator_Abstract

Clear all options

Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicgetElement( ) : \Zend_Form_Element|\Zend_Form

Retrieve current element

Inherited from: \Zend_Form_Decorator_Abstract::getElement()
Returns
Type Description
\Zend_Form_Element\Zend_Form
methodpublicgetOption( string $key ) : mixed

Get option

Inherited from: \Zend_Form_Decorator_Abstract::getOption()
Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublicgetOptions( ) : array

Retrieve options

Inherited from: \Zend_Form_Decorator_Abstract::getOptions()
Returns
Type Description
array
methodpublicgetPlacement( ) : string

Determine if decorator should append or prepend content

Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()
Returns
Type Description
string
methodpublicgetSeparator( ) : string

Retrieve separator to use between old and new content

Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()
Returns
Type Description
string
methodpublicgetTag( ) : string

Get tag

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

Returns
Type Description
string
methodpublicnormalizeTag( string $tag ) : string

Normalize tag

Ensures tag is alphanumeric characters only, and all lowercase.

Parameters
Name Type Description
$tag string
Returns
Type Description
string
methodpublicremoveOption( mixed $key ) : void

Remove single option

Inherited from: \Zend_Form_Decorator_Abstract::removeOption()
Parameters
Name Type Description
$key mixed
methodpublicrender( string $content ) : string

Render content wrapped in an HTML tag

Parameters
Name Type Description
$content string
Returns
Type Description
string
Throws
Exception Description
\Zend_Form_Decorator_Exception when unimplemented
methodpublicsetConfig( \Zend_Config $config ) : \Zend_Form_Decorator_Abstract

Set options from config object

Inherited from: \Zend_Form_Decorator_Abstract::setConfig()
Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicsetElement( \Zend_Form_Element|\Zend_Form $element ) : \Zend_Form_Decorator_Abstract

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
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
methodpublicsetOption( string $key, mixed $value ) : \Zend_Form_Decorator_Abstract

Set option

Inherited from: \Zend_Form_Decorator_Abstract::setOption()
Parameters
Name Type Description
$key string
$value mixed
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicsetOptions( array $options ) : \Zend_Form_Decorator_Abstract

Set options

Inherited from: \Zend_Form_Decorator_Abstract::setOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicsetTag( string $tag ) : \Zend_Form_Decorator_HtmlTag

Set tag to use

Parameters
Name Type Description
$tag string
Returns
Type Description
\Zend_Form_Decorator_HtmlTag
Documentation was generated by DocBlox 0.13.3.