Form/Decorator/Label.php

Show: PublicProtectedPrivateinherited
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_Label

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

>VConstant  IMPLICIT = 'IMPLICIT'
Placement constants
>VConstant  IMPLICIT_PREPEND = 'IMPLICIT_PREPEND'
>VConstant  IMPLICIT_APPEND = 'IMPLICIT_APPEND'
>VConstant  APPEND = 'APPEND'
inherited
Placement constants
Inherited from: \Zend_Form_Decorator_Abstract::APPEND
>VConstant  PREPEND = 'PREPEND'

Properties

>VPropertyprotected\Zend_Form_Element|\Zend_Form $_element
>VPropertyprotectedarray $_options = array()
inherited
Decorator options
Inherited from: \Zend_Form_Decorator_Abstract::$$_options
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Decorator_Abstract::$$_options  
>VPropertyprotectedstring $_placement = 'PREPEND'
Default placement: prepend
Default value'PREPEND'Details
Type
string
>VPropertyprotectedstring $_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  
>VPropertyprotectedstring $_tag
HTML tag with which to surround label
Details
Type
string
>VPropertyprotectedstring $_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
NameTypeDescription
$methodstring
$argsarray
Returns
TypeDescription
mixed
Throws
ExceptionDescription
\Zend_Form_Exceptionfor unsupported methods
methodpublic__construct(array | \Zend_Config $options = null) : void
inherited

Constructor

Inherited from: \Zend_Form_Decorator_Abstract::__construct()

Accept options during initialization.

Parameters
NameTypeDescription
$optionsarray | \Zend_Config
methodprotected_loadOptReqKey(string $key) : void

Load an optional/required suffix/prefix key

Parameters
NameTypeDescription
$keystring
methodpublicclearOptions() : \Zend_Form_Decorator_Abstract
inherited

Clear all options

Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()
Returns
TypeDescription
\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
TypeDescription
string
methodpublicgetElement() : \Zend_Form_Element | \Zend_Form
inherited

Retrieve current element

Inherited from: \Zend_Form_Decorator_Abstract::getElement()
Returns
TypeDescription
\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
TypeDescription
string
methodpublicgetLabel() : string

Get label to render

Returns
TypeDescription
string
methodpublicgetOption(string $key) : mixed
inherited

Get option

Inherited from: \Zend_Form_Decorator_Abstract::getOption()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetOptions() : array
inherited

Retrieve options

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

Determine if label should append, prepend or implicit content

Returns
TypeDescription
string
methodpublicgetSeparator() : string
inherited

Retrieve separator to use between old and new content

Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()
Returns
TypeDescription
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
inherited

Remove single option

Inherited from: \Zend_Form_Decorator_Abstract::removeOption()
Parameters
NameTypeDescription
$keymixed
methodpublicrender(string $content) : string

Render a label

Parameters
NameTypeDescription
$contentstring
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Form_Decorator_Exceptionwhen unimplemented
methodpublicsetConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract
inherited

Set options from config object

Inherited from: \Zend_Form_Decorator_Abstract::setConfig()
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetElement(\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
NameTypeDescription
$element\Zend_Form_Element | \Zend_Form
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
Throws
ExceptionDescription
\Zend_Form_Decorator_Exceptionon invalid element type
methodpublicsetId(string $id) : \Zend_Form_Decorator_Label

Set element ID

Parameters
NameTypeDescription
$idstring
Returns
TypeDescription
\Zend_Form_Decorator_Label
methodpublicsetOption(string $key, mixed $value) : \Zend_Form_Decorator_Abstract
inherited

Set option

Inherited from: \Zend_Form_Decorator_Abstract::setOption()
Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetOptions(array $options) : \Zend_Form_Decorator_Abstract
inherited

Set options

Inherited from: \Zend_Form_Decorator_Abstract::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetTag(string $tag) : \Zend_Form_Decorator_Label

Set HTML tag with which to surround label

Parameters
NameTypeDescription
$tagstring
Returns
TypeDescription
\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
NameTypeDescription
$tagClassstring
Returns
TypeDescription
\Zend_Form_Decorator_Label
Documentation was generated by phpDocumentor 2.0.0a12.