Class Zend_Form_Decorator_HtmlTag

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.

  • version: $Id: HtmlTag.php 20104 2010-01-06 21:26:01Z matthew $
  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Form/Decorator/HtmlTag.php (line 50)

Zend_Form_Decorator_Abstract
   |
   --Zend_Form_Decorator_HtmlTag
Variable Summary
Method Summary
 string getTag ()
 string normalizeTag (string $tag)
 string render (string $content)
 string _getCloseTag (string $tag)
 string _getEncoding ()
 string _getOpenTag (string $tag, [ $attribs = null])
 string _htmlAttribs ( $attribs)
Variables
string $_encoding (line 56)

Character encoding to use when escaping attributes

  • access: protected
string $_placement = null (line 62)

Placement; default to surround content

  • access: protected

Redefinition of:
Zend_Form_Decorator_Abstract::$_placement
Default placement: append
string $_tag (line 68)

HTML tag to use

  • access: protected
Zend_Filter $_tagFilter (line 73)
  • access: protected

Inherited Variables

Inherited from Zend_Form_Decorator_Abstract

Zend_Form_Decorator_Abstract::$_element
Zend_Form_Decorator_Abstract::$_options
Zend_Form_Decorator_Abstract::$_separator
Methods
getTag (line 135)

Get tag

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

  • access: public
string getTag ()
normalizeTag (line 103)

Normalize tag

Ensures tag is alphanumeric characters only, and all lowercase.

  • access: public
string normalizeTag (string $tag)
  • string $tag
render (line 183)

Render content wrapped in an HTML tag

  • access: public
string render (string $content)
  • string $content

Redefinition of:
Zend_Form_Decorator_Abstract::render()
Decorate content and/or element
setTag (line 122)

Set tag to use

  • access: public
Zend_Form_Decorator_HtmlTag setTag (string $tag)
  • string $tag
_getCloseTag (line 172)

Get formatted closing tag

  • access: protected
string _getCloseTag (string $tag)
  • string $tag
_getEncoding (line 232)

Get encoding for use with htmlspecialchars()

  • access: protected
string _getEncoding ()
_getOpenTag (line 156)

Get the formatted open tag

  • access: protected
string _getOpenTag (string $tag, [ $attribs = null])
  • string $tag
  • array $attribs
_htmlAttribs (line 80)

Convert options to tag attributes

  • access: protected
string _htmlAttribs ( $attribs)
  • array $attribs

Inherited Methods

Inherited From Zend_Form_Decorator_Abstract

 Zend_Form_Decorator_Abstract::__construct()
 Zend_Form_Decorator_Abstract::clearOptions()
 Zend_Form_Decorator_Abstract::getElement()
 Zend_Form_Decorator_Abstract::getOption()
 Zend_Form_Decorator_Abstract::getOptions()
 Zend_Form_Decorator_Abstract::getPlacement()
 Zend_Form_Decorator_Abstract::getSeparator()
 Zend_Form_Decorator_Abstract::removeOption()
 Zend_Form_Decorator_Abstract::render()
 Zend_Form_Decorator_Abstract::setConfig()
 Zend_Form_Decorator_Abstract::setElement()
 Zend_Form_Decorator_Abstract::setOption()
 Zend_Form_Decorator_Abstract::setOptions()
Class Constants

Documentation generated on Mon, 21 Jun 2010 15:27:14 -0400 by phpDocumentor 1.4.3