Form/Decorator/Label.php

Show:

inherited

Classes
- \Zend_Form_Decorator_Label

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 [email protected] 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_Label
jump to top

Package: Zend\Form\Decorator

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 - tagClass: if tag option is set, used to add a class to the label wrapper - opt(ional)Prefix: a prefix to the label to use when the element is optional - opt(ional)Suffix: 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.

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: Label.php 25243 2013-01-22 12:07:26Z frosch $

Constants

 
                IMPLICIT
                = 'IMPLICIT'

Placement constants

 
                IMPLICIT_PREPEND
                = 'IMPLICIT_PREPEND'

 
                IMPLICIT_APPEND
                = 'IMPLICIT_APPEND'

 
                APPEND
                = 'APPEND'

inherited

Placement constants

Inherited from: \Zend_Form_Decorator_Abstract::APPEND

Inherited_from: \Zend_Form_Decorator_Abstract::APPEND

 
                PREPEND
                = 'PREPEND'

inheritedInherited from: \Zend_Form_Decorator_Abstract::PREPEND

Inherited_from: \Zend_Form_Decorator_Abstract::PREPEND

Properties

\Zend_Form_Element|\Zend_Form $_element =

inherited

Inherited from: \Zend_Form_Decorator_Abstract::$$_element

Details

Type: \Zend_Form_Element | \Zend_Form
Inherited_from: \Zend_Form_Decorator_Abstract::$$_element

array $_options = array()

inherited

Decorator options

Inherited from: \Zend_Form_Decorator_Abstract::$$_options

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_Decorator_Abstract::$$_options

string $_placement = 'PREPEND'

Default placement: prepend

Default value'PREPEND'Details

Type: string

string $_separator = PHP_EOL

inherited

Separator between new content and old

Inherited from: \Zend_Form_Decorator_Abstract::$$_separator

Default valuePHP_EOLDetails

Type: string
Inherited_from: \Zend_Form_Decorator_Abstract::$$_separator

string $_tag =

HTML tag with which to surround label

Details

Type: string

string $_tagClass =

Class for the HTML tag with which to surround label

Details

Type: string

Methods

__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

__construct(array | \Zend_Config $options = null) : void

inherited

Constructor

Inherited from: \Zend_Form_Decorator_Abstract::__construct()

Accept options during initialization.

Parameters

Name	Type	Description
$options	array \| \Zend_Config

_loadOptReqKey(string $key) : void

Load an optional/required suffix/prefix key

Parameters

Name	Type	Description
$key	string

clearOptions() : \Zend_Form_Decorator_Abstract

inherited

Clear all options

Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()

Returns

Type	Description
\Zend_Form_Decorator_Abstract

getClass() : 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

getElement() : \Zend_Form_Element | \Zend_Form

inherited

Retrieve current element

Inherited from: \Zend_Form_Decorator_Abstract::getElement()

Returns

Type	Description
\Zend_Form_Element \| \Zend_Form

getId() : 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

getLabel() : string

Get label to render

Returns

Type	Description
string

getOption(string $key) : mixed

inherited

Get option

Inherited from: \Zend_Form_Decorator_Abstract::getOption()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getOptions() : array

inherited

Retrieve options

Inherited from: \Zend_Form_Decorator_Abstract::getOptions()

Returns

Type	Description
array

getPlacement() : string

Determine if label should append, prepend or implicit content

Returns

Type	Description
string

getSeparator() : string

inherited

Retrieve separator to use between old and new content

Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()

Returns

Type	Description
string

getTag() : void

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

getTagClass() : void

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

removeOption(mixed $key) : void

inherited

Remove single option

Inherited from: \Zend_Form_Decorator_Abstract::removeOption()

Parameters

Name	Type	Description
$key	mixed

render(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

setConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract

inherited

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

setElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract

inherited

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

setId(string $id) : \Zend_Form_Decorator_Label

Set element ID

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
\Zend_Form_Decorator_Label

setOption(string $key, mixed $value) : \Zend_Form_Decorator_Abstract

inherited

Set option

Inherited from: \Zend_Form_Decorator_Abstract::setOption()

Parameters

Name	Type	Description
$key	string
$value	mixed

Returns

Type	Description
\Zend_Form_Decorator_Abstract

setOptions(array $options) : \Zend_Form_Decorator_Abstract

inherited

Set options

Inherited from: \Zend_Form_Decorator_Abstract::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Form_Decorator_Abstract

setTag(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

setTagClass(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

Form/Decorator/Label.php

\Zend_Form_Decorator_Labeljump to top

Constants

Properties

Methods

\Zend_Form_Decorator_Label
jump to top