API Documentation

Zend/Form/Decorator/HtmlTag.php

Show: inherited
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 24594 2012-01-05 21:27:01Z 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

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
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
methodpublicrender( string $content ) : string

Render content wrapped in an HTML tag

Parameters
Name Type Description
$content string
Returns
Type Description
string
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.15.1.