View/Helper/FormNote.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 [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_View  
Subpackage
Helper  
Version
$Id: FormNote.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_View_Helper_FormNote
jump to top

Package: Zend\View\Helper

Helper to show an HTML note

Extend this, don't use it on its own.

Parent(s)
\Zend_View_Helper_FormElement < \Zend_View_Helper_HtmlElement < \Zend_View_Helper_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  EOL = "\n"
inherited

EOL character

Inherited from: \Zend_View_Helper_HtmlElement::EOL\Zend_View_Helper_FormElement::EOL
Inherited_from
\Zend_View_Helper_HtmlElement::EOL  
Inherited_from
\Zend_View_Helper_FormElement::EOL  

Properties

Propertyprotectedstring $_closingBracket = null
inherited

The tag closing bracket

Inherited from: \Zend_View_Helper_HtmlElement::$$_closingBracket\Zend_View_Helper_FormElement::$$_closingBracket
Default valuenullDetails
Type
string
Inherited_from
\Zend_View_Helper_HtmlElement::$$_closingBracket  
Inherited_from
\Zend_View_Helper_FormElement::$$_closingBracket  
Propertyprotected\Zend_Translate_Adapter|null $_translator =
inherited

Inherited from: \Zend_View_Helper_FormElement::$$_translator
Details
Type
\Zend_Translate_Adapter | null
Inherited_from
\Zend_View_Helper_FormElement::$$_translator  
Propertypublic\Zend_View_Interface $view = null
inherited

View object

Inherited from: \Zend_View_Helper_Abstract::$$view\Zend_View_Helper_HtmlElement::$$view\Zend_View_Helper_FormElement::$$view
Default valuenullDetails
Type
\Zend_View_Interface
Inherited_from
\Zend_View_Helper_Abstract::$$view  
Inherited_from
\Zend_View_Helper_HtmlElement::$$view  
Inherited_from
\Zend_View_Helper_FormElement::$$view  

Methods

methodprotected_getInfo( $name,  $value = null,  $attribs = null,  $options = null,  $listsep = null) : array
inherited

Converts parameter arguments to an element info array.

Inherited from: \Zend_View_Helper_FormElement::_getInfo()

E.g, formExample($name, $value, $attribs, $options, $listsep) is the same thing as formExample(array('name' => ...)).

Note that you cannot pass a 'disable' param; you need to pass it as an 'attribs' key.

Parameters
Name Type Description
$name
$value
$attribs
$options
$listsep
Returns
Type Description
array An element info array with keys for name, value, attribs, options, listsep, disable, and escape.
Details
Access
protected  
methodprotected_hidden(string $name, string $value = null, array $attribs = null) : string
inherited

Creates a hidden element.

Inherited from: \Zend_View_Helper_FormElement::_hidden()

We have this as a common method because other elements often need hidden elements for their operation.

Parameters
Name Type Description
$name string

The element name.
$value string

The element value.
$attribs array

Attributes for the element.
Returns
Type Description
string A hidden element.
Details
Access
protected  
methodprotected_htmlAttribs(array $attribs) : string
inherited

Converts an associative array to a string of tag attributes.

Inherited from: \Zend_View_Helper_HtmlElement::_htmlAttribs()\Zend_View_Helper_FormElement::_htmlAttribs()
Parameters
Name Type Description
$attribs array

From this array, each key-value pair is converted to an attribute name and value.
Returns
Type Description
string The XHTML for the attributes.
Details
Access
public  
methodprotected_isStrictDoctype() : boolean
inherited

Is doctype strict?

Inherited from: \Zend_View_Helper_HtmlElement::_isStrictDoctype()\Zend_View_Helper_FormElement::_isStrictDoctype()
Returns
Type Description
boolean
methodprotected_isXhtml() : boolean
inherited

Is doctype XHTML?

Inherited from: \Zend_View_Helper_HtmlElement::_isXhtml()\Zend_View_Helper_FormElement::_isXhtml()
Returns
Type Description
boolean
methodprotected_normalizeId(string $value) : string
inherited

Normalize an ID

Inherited from: \Zend_View_Helper_HtmlElement::_normalizeId()\Zend_View_Helper_FormElement::_normalizeId()
Parameters
Name Type Description
$value string
Returns
Type Description
string
methodpublicdirect() : void
inherited

Strategy pattern: currently unutilized

Inherited from: \Zend_View_Helper_Abstract::direct()\Zend_View_Helper_HtmlElement::direct()\Zend_View_Helper_FormElement::direct()
methodpublicformNote(string | array $name, array $value = null) : string

Helper to show a "note" based on a hidden value.

Parameters
Name Type Description
$name string | array

If a string, the element name. If an array, all other parameters are ignored, and the array elements are extracted in place of added parameters.
$value array

The note to display. HTML is not escaped; the note is displayed as-is.
Returns
Type Description
string The element XHTML.
Details
Access
public  
methodpublicgetClosingBracket() : string
inherited

Get the tag closing bracket

Inherited from: \Zend_View_Helper_HtmlElement::getClosingBracket()\Zend_View_Helper_FormElement::getClosingBracket()
Returns
Type Description
string
methodpublicgetTranslator() : \Zend_Translate_Adapter | null
inherited

Get translator

Inherited from: \Zend_View_Helper_FormElement::getTranslator()
Returns
Type Description
\Zend_Translate_Adapter | null
methodpublicsetTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : \Zend_View_Helper_FormElement
inherited

Set translator

Inherited from: \Zend_View_Helper_FormElement::setTranslator()
Parameters
Name Type Description
$translator \Zend_Translate | \Zend_Translate_Adapter | null
Returns
Type Description
\Zend_View_Helper_FormElement
methodpublicsetView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract
inherited

Set the View object

Inherited from: \Zend_View_Helper_Abstract::setView()\Zend_View_Helper_HtmlElement::setView()\Zend_View_Helper_FormElement::setView()
Parameters
Name Type Description
$view \Zend_View_Interface
Returns
Type Description
\Zend_View_Helper_Abstract
Documentation was generated by phpDocumentor 2.0.0a8.