API Documentation

Form/Decorator/Label.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Form  
subpackage
Decorator  

\Zend_Form_Decorator_Label

Zend_Form_Decorator_Label

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 - opt(ional)Prefix: a prefix to the label to use when the element is optional - opt(iona)lSuffix: a suffix to the label to use when the element is optional - req(uired)Prefix: a prefix to the label to use when the element is required - req(uired)Suffix: a suffix to the label to use when the element is required

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

Extends from
\Zend_Form_Decorator_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Form  
subpackage
Decorator  
version
$Id: Label.php 23960 2011-05-03 10:58:52Z yoshida@zend.co.jp $  

Properties

Propertyprotectedstring  $_placement= 'PREPEND'

Default placement: prepend

Default valuePREPENDDetails
Type
string
Propertyprotectedstring  $_tag= ''

HTML tag with which to surround label

Details
Type
string
Propertyprotectedstring  $_tagClass= ''

Class for the HTML tag with which to surround label

Details
Type
string

Methods

methodpublic__call( string $method, array $args ) : mixed

Overloading

Currently overloads:

  • getOpt(ional)Prefix()
  • getOpt(ional)Suffix()
  • getReq(uired)Prefix()
  • getReq(uired)Suffix()
  • setOpt(ional)Prefix()
  • setOpt(ional)Suffix()
  • setReq(uired)Prefix()
  • setReq(uired)Suffix()
Parameters
Name Type Description
$method string
$args array
Returns
Type Description
mixed
Throws
Exception Description
\Zend_Form_Exception for unsupported methods
methodpublic__construct( array|\Zend_Config $options = null ) : void

Constructor

Inherited from: \Zend_Form_Decorator_Abstract::__construct()

Accept options during initialization.

Parameters
Name Type Description
$options array|\Zend_Config
methodprotected_loadOptReqKey( string $key ) : void

Load an optional/required suffix/prefix key

Parameters
Name Type Description
$key string
methodpublicclearOptions( ) : \Zend_Form_Decorator_Abstract

Clear all options

Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicgetClass( ) : string

Get class with which to define label

Appends either 'optional' or 'required' to class, depending on whether or not the element is required.

Returns
Type Description
string
methodpublicgetElement( ) : \Zend_Form_Element|\Zend_Form

Retrieve current element

Inherited from: \Zend_Form_Decorator_Abstract::getElement()
Returns
Type Description
\Zend_Form_Element\Zend_Form
methodpublicgetId( ) : string

Retrieve element ID (used in 'for' attribute)

If none set in decorator, looks first for element 'id' attribute, and defaults to element name.

Returns
Type Description
string
methodpublicgetLabel( ) : string

Get label to render

Returns
Type Description
string
methodpublicgetOption( string $key ) : mixed

Get option

Inherited from: \Zend_Form_Decorator_Abstract::getOption()
Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublicgetOptions( ) : array

Retrieve options

Inherited from: \Zend_Form_Decorator_Abstract::getOptions()
Returns
Type Description
array
methodpublicgetPlacement( ) : string

Determine if decorator should append or prepend content

Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()
Returns
Type Description
string
methodpublicgetSeparator( ) : string

Retrieve separator to use between old and new content

Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()
Returns
Type Description
string
methodpublicgetTag( ) : void

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

methodpublicgetTagClass( ) : void

Get the class to apply to the HTML tag, if any, with which to surround label

methodpublicremoveOption( mixed $key ) : void

Remove single option

Inherited from: \Zend_Form_Decorator_Abstract::removeOption()
Parameters
Name Type Description
$key mixed
methodpublicrender( string $content ) : string

Render a label

Parameters
Name Type Description
$content string
Returns
Type Description
string
Throws
Exception Description
\Zend_Form_Decorator_Exception when unimplemented
methodpublicsetConfig( \Zend_Config $config ) : \Zend_Form_Decorator_Abstract

Set options from config object

Inherited from: \Zend_Form_Decorator_Abstract::setConfig()
Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicsetElement( \Zend_Form_Element|\Zend_Form $element ) : \Zend_Form_Decorator_Abstract

Set current form element

Inherited from: \Zend_Form_Decorator_Abstract::setElement()

While the name is "setElement", a form decorator could decorate either an element or a form object.

Parameters
Name Type Description
$element \Zend_Form_Element|\Zend_Form
Returns
Type Description
\Zend_Form_Decorator_Abstract
Throws
Exception Description
\Zend_Form_Decorator_Exception on invalid element type
methodpublicsetId( string $id ) : \Zend_Form_Decorator_Label

Set element ID

Parameters
Name Type Description
$id string
Returns
Type Description
\Zend_Form_Decorator_Label
methodpublicsetOption( string $key, mixed $value ) : \Zend_Form_Decorator_Abstract

Set option

Inherited from: \Zend_Form_Decorator_Abstract::setOption()
Parameters
Name Type Description
$key string
$value mixed
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicsetOptions( array $options ) : \Zend_Form_Decorator_Abstract

Set options

Inherited from: \Zend_Form_Decorator_Abstract::setOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicsetTag( string $tag ) : \Zend_Form_Decorator_Label

Set HTML tag with which to surround label

Parameters
Name Type Description
$tag string
Returns
Type Description
\Zend_Form_Decorator_Label
methodpublicsetTagClass( string $tagClass ) : \Zend_Form_Decorator_Label

Set the class to apply to the HTML tag with which to surround label

Parameters
Name Type Description
$tagClass string
Returns
Type Description
\Zend_Form_Decorator_Label
Documentation was generated by DocBlox 0.13.3.