API Documentation

Form/Decorator/HtmlTag.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Form
subpackage
Decorator
Classes
Zend_Form_Decorator_HtmlTag

Description

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.

Zend_Form_Decorator_HtmlTag

Extends from
Zend_Form_Decorator_Abstract
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Form
subpackage
Decorator
version
$Id: HtmlTag.php 20104 2010-01-06 21:26:01Z matthew $
Properties
$_encoding
$_placement
$_tag
$_tagFilter
Methods
_htmlAttribs
normalizeTag
setTag
getTag
_getOpenTag
_getCloseTag
render
_getEncoding

Description

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.

Properties

$_encoding

string $_encoding = ''

Character encoding to use when escaping attributes

Details

$_encoding
string
visibility
protected
default
final
false
static
false

$_placement

string $_placement = 'null'

Placement; default to surround content

Details

$_placement
string
visibility
protected
default
null
final
false
static
false

$_tag

string $_tag = ''

HTML tag to use

Details

$_tag
string
visibility
protected
default
final
false
static
false

$_tagFilter

Zend_Filter $_tagFilter = ''

Details

$_tagFilter
Zend_Filter
visibility
protected
default
final
false
static
false

Methods

_getCloseTag

_getCloseTag( string $tag ) : string

Get formatted closing tag

Arguments
$tag
string
Output
string
Details
visibility
protected
final
false
static
false

_getEncoding

_getEncoding( ) : string

Get encoding for use with htmlspecialchars()

Output
string
Details
visibility
protected
final
false
static
false

_getOpenTag

_getOpenTag( string $tag, array $attribs = null ) : string

Get the formatted open tag

Arguments
$tag
string
$attribs
array
Output
string
Details
visibility
protected
final
false
static
false

_htmlAttribs

_htmlAttribs(  $attribs ) : string

Convert options to tag attributes

Arguments
$attribs
Output
string
Details
visibility
protected
final
false
static
false

getTag

getTag( ) : string

Get tag

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

Output
string
Details
visibility
public
final
false
static
false

normalizeTag

normalizeTag( string $tag ) : string

Normalize tag

Ensures tag is alphanumeric characters only, and all lowercase.

Arguments
$tag
string
Output
string
Details
visibility
public
final
false
static
false

render

render( string $content ) : string

Render content wrapped in an HTML tag

Arguments
$content
string
Output
string
Details
visibility
public
final
false
static
false

setTag

setTag( string $tag ) : Zend_Form_Decorator_HtmlTag

Set tag to use

Arguments
$tag
string
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.