API Documentation

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

Package: Zend\Form\Decorator

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.

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: Description.php 24594 2012-01-05 21:27:01Z matthew $  

Properties

Propertyprotectedbool  $_escape= ''

Whether or not to escape the description

Details
Type
bool
Propertyprotectedstring  $_placement= ''APPEND''

Default placement: append

Default value'APPEND'Details
Type
string
Propertyprotectedstring  $_tag= ''

HTML tag with which to surround description

Details
Type
string

Methods

methodpublicgetClass( ) : string

Get class with which to define description

Defaults to 'hint'

Returns
Type Description
string
methodpublicgetEscape( ) : true

Get escape flag

Returns
Type Description
true
methodpublicgetTag( ) : string

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

Returns
Type Description
string
methodpublicrender( string $content ) : string

Render a description

Parameters
Name Type Description
$content string
Returns
Type Description
string
methodpublicsetEscape( bool $flag ) : \Zend_Form_Decorator_Description

Set whether or not to escape description

Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Form_Decorator_Description
methodpublicsetTag( string $tag ) : \Zend_Form_Decorator_Description

Set HTML tag with which to surround description

Parameters
Name Type Description
$tag string
Returns
Type Description
\Zend_Form_Decorator_Description
Documentation was generated by DocBlox 0.15.1.