API Documentation

Form/Decorator/Description.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_Description

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_Description

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: Description.php 20096 2010-01-06 02:05:09Z bkarwin $
Properties
$_escape
$_placement
$_tag
Methods
setTag
getTag
getClass
setEscape
getEscape
render

Description

Zend_Form_Decorator_Description

Accepts the options: - separator: separator to use between label and content (defaults to PHP_EOL) - placement: whether to append or prepend label to content (defaults to prepend) - tag: if set, used to wrap the label in an additional HTML tag - class: if set, override default class used with HTML tag - escape: whether or not to escape description (true by default)

Any other options passed will be used as HTML attributes of the HTML tag used.

Properties

$_escape

bool $_escape = ''

Whether or not to escape the description

Details

$_escape
bool
visibility
protected
default
final
false
static
false

$_placement

string $_placement = 'APPEND'

Default placement: append

Details

$_placement
string
visibility
protected
default
APPEND
final
false
static
false

$_tag

string $_tag = ''

HTML tag with which to surround description

Details

$_tag
string
visibility
protected
default
final
false
static
false

Methods

getClass

getClass( ) : string

Get class with which to define description

Defaults to 'hint'

Output
string
Details
visibility
public
final
false
static
false

getEscape

getEscape( ) : true

Get escape flag

Output
true
Details
visibility
public
final
false
static
false

getTag

getTag( ) : string

Get HTML tag, if any, with which to surround description

Output
string
Details
visibility
public
final
false
static
false

render

render( string $content ) : string

Render a description

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

setEscape

setEscape( bool $flag ) : Zend_Form_Decorator_Description

Set whether or not to escape description

Arguments
$flag
bool
Details
visibility
public
final
false
static
false

setTag

setTag( string $tag ) : Zend_Form_Decorator_Description

Set HTML tag with which to surround description

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