Base functionality for all form view helpers

 Methods

Create a string of all attribute/value pairs

createAttributesString(array $attributes) : string

Escapes all attribute values

Parameters

$attributes

array

Returns

string

Get value for doctype

getDoctype() : string

Returns

string

Get character encoding

getEncoding() : string

Returns

string

Get the ID of an element

getId(\Zend\Form\ElementInterface $element) : null | string

If no ID attribute present, attempts to use the name attribute. If no name attribute is present, either, returns null.

Parameters

Returns

nullstring

Get the closing bracket for an inline tag

getInlineClosingBracket() : string

Closes as either "/>" for XHTML doctypes or ">" otherwise.

Returns

string

Returns translator used in helper

getTranslator() : \Zend\I18n\Translator\Translator | null
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::getTranslator()

Returns

Return the translation text domain

getTranslatorTextDomain() : string
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::getTranslatorTextDomain()

Returns

string

Get the view object

getView() : null | \Zend\View\Renderer\RendererInterface
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::getView()
inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::getView()

Returns

Checks if the helper has a translator

hasTranslator() : bool
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::hasTranslator()

Returns

bool

Returns whether translator is enabled and should be used

isTranslatorEnabled() : bool
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::isTranslatorEnabled()

Returns

bool

Set value for doctype

setDoctype(string $doctype) : \Zend\Form\View\Helper\AbstractHelper

Parameters

$doctype

string

Returns

Set value for character encoding

setEncoding(string $encoding) : \Zend\Form\View\Helper\AbstractHelper

Parameters

$encoding

string

Returns

Sets translator to use in helper

setTranslator(\Zend\I18n\Translator\Translator $translator, string $textDomain) : \Zend\I18n\View\Helper\AbstractTranslatorHelper
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::setTranslator()

Parameters

$translator

\Zend\I18n\Translator\Translator

[optional] translator. Default is null, which sets no translator.

$textDomain

string

[optional] text domain Default is null, which skips setTranslatorTextDomain

Returns

Sets whether translator is enabled and should be used

setTranslatorEnabled(bool $enabled) : \Zend\I18n\View\Helper\AbstractTranslatorHelper
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::setTranslatorEnabled()

Parameters

$enabled

bool

[optional] whether translator should be used. Default is true.

Returns

Set translation text domain

setTranslatorTextDomain(string $textDomain) : \Zend\I18n\View\Helper\AbstractTranslatorHelper
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::setTranslatorTextDomain()

Parameters

$textDomain

string

Returns

Set the View object

setView(\Zend\View\Renderer\RendererInterface $view) : \Zend\View\Helper\AbstractHelper
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::setView()
inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::setView()

Parameters

Returns

Retrieve the doctype helper

getDoctypeHelper() : \Zend\View\Helper\Doctype

Retrieve the escapeHtmlAttr helper

getEscapeHtmlAttrHelper() : \Zend\View\Helper\EscapeHtmlAttr

Retrieve the escapeHtml helper

getEscapeHtmlHelper() : \Zend\View\Helper\EscapeHtml

Prepare attributes for rendering

prepareAttributes(array $attributes) : array

Ensures appropriate attributes are present (e.g., if "name" is present, but no "id", sets the latter to the former).

Removes any invalid attributes

Parameters

$attributes

array

Returns

array

Prepare a boolean attribute value

prepareBooleanAttributeValue(string $attribute, mixed $value) : string

Prepares the expected representation for the boolean attribute specified.

Parameters

$attribute

string

$value

mixed

Returns

string

 Properties

 

Standard boolean attributes, with expected values for enabling/disabling

$booleanAttributes : array

 

$doctypeHelper

$doctypeHelper : \Zend\View\Helper\Doctype

 

$escapeHtmlAttrHelper

$escapeHtmlAttrHelper : \Zend\View\Helper\EscapeHtmlAttr

 

$escapeHtmlHelper

$escapeHtmlHelper : \Zend\View\Helper\EscapeHtml

 

Translatable attributes

$translatableAttributes : array

 

Translator (optional)

$translator : \Zend\I18n\Translator\Translator
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$translator
 

Whether translator should be used

$translatorEnabled : bool
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$translatorEnabled
 

Translator text domain (optional)

$translatorTextDomain : string
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$translatorTextDomain
 

Attributes globally valid for all tags

$validGlobalAttributes : array

 

Attributes valid for the tag represented by this helper

$validTagAttributes : array

This should be overridden in extending classes

 

View object

$view : \Zend\View\Renderer\RendererInterface
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::$$view
inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$view