Zend Framework
Back to top  

Base functionality for all form view helpers

 Methods

Invoke helper as functor

__invoke(\Zend\Form\ElementInterface $element) : string | \Zend\Form\View\Helper\FormInput
Inherited

Proxies to render().

inherited_from \Zend\Form\View\Helper\FormInput::__invoke()

Parameters

$element

\Zend\Form\ElementInterfacenull

Returns

string\Zend\Form\View\Helper\FormInput

Create a string of all attribute/value pairs

createAttributesString(array $attributes) : string
Inherited

Escapes all attribute values

inherited_from \Zend\Form\View\Helper\AbstractHelper::createAttributesString()
inherited_from \Zend\Form\View\Helper\FormInput::createAttributesString()

Parameters

$attributes

array

Returns

string

Get value for doctype

getDoctype() : string
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::getDoctype()
inherited_from \Zend\Form\View\Helper\FormInput::getDoctype()

Returns

string

Get character encoding

getEncoding() : string
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::getEncoding()
inherited_from \Zend\Form\View\Helper\FormInput::getEncoding()

Returns

string

Get the ID of an element

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

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

inherited_from \Zend\Form\View\Helper\AbstractHelper::getId()
inherited_from \Zend\Form\View\Helper\FormInput::getId()

Parameters

$element

\Zend\Form\ElementInterface

Returns

nullstring

Get the closing bracket for an inline tag

getInlineClosingBracket() : string
Inherited

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

inherited_from \Zend\Form\View\Helper\AbstractHelper::getInlineClosingBracket()
inherited_from \Zend\Form\View\Helper\FormInput::getInlineClosingBracket()

Returns

string

Returns translator used in helper

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

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::getTranslator()
inherited_from \Zend\Form\View\Helper\AbstractHelper::getTranslator()
inherited_from \Zend\Form\View\Helper\FormInput::getTranslator()

Returns

\Zend\I18n\Translator\TranslatorInterfacenull

Return the translation text domain

getTranslatorTextDomain() : string
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::getTranslatorTextDomain()
inherited_from \Zend\Form\View\Helper\AbstractHelper::getTranslatorTextDomain()
inherited_from \Zend\Form\View\Helper\FormInput::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()
inherited_from \Zend\Form\View\Helper\AbstractHelper::getView()
inherited_from \Zend\Form\View\Helper\FormInput::getView()

Returns

null\Zend\View\Renderer\RendererInterface

Checks if the helper has a translator

hasTranslator() : bool
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::hasTranslator()
inherited_from \Zend\Form\View\Helper\AbstractHelper::hasTranslator()
inherited_from \Zend\Form\View\Helper\FormInput::hasTranslator()

Returns

bool

Returns whether translator is enabled and should be used

isTranslatorEnabled() : bool
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::isTranslatorEnabled()
inherited_from \Zend\Form\View\Helper\AbstractHelper::isTranslatorEnabled()
inherited_from \Zend\Form\View\Helper\FormInput::isTranslatorEnabled()

Returns

bool

Render a form <input> element from the provided $element

render(\Zend\Form\ElementInterface $element) : string
Inherited

inherited_from \Zend\Form\View\Helper\FormInput::render()

Parameters

$element

\Zend\Form\ElementInterface

Exceptions

\Zend\Form\Exception\DomainException

Returns

string

Set value for doctype

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

inherited_from \Zend\Form\View\Helper\AbstractHelper::setDoctype()
inherited_from \Zend\Form\View\Helper\FormInput::setDoctype()

Parameters

$doctype

string

Returns

\Zend\Form\View\Helper\AbstractHelper

Set value for character encoding

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

inherited_from \Zend\Form\View\Helper\AbstractHelper::setEncoding()
inherited_from \Zend\Form\View\Helper\FormInput::setEncoding()

Parameters

$encoding

string

Returns

\Zend\Form\View\Helper\AbstractHelper

Sets translator to use in helper

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

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::setTranslator()
inherited_from \Zend\Form\View\Helper\AbstractHelper::setTranslator()
inherited_from \Zend\Form\View\Helper\FormInput::setTranslator()

Parameters

$translator

\Zend\I18n\Translator\TranslatorInterface

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

$textDomain

string

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

Returns

\Zend\I18n\View\Helper\AbstractTranslatorHelper

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()
inherited_from \Zend\Form\View\Helper\AbstractHelper::setTranslatorEnabled()
inherited_from \Zend\Form\View\Helper\FormInput::setTranslatorEnabled()

Parameters

$enabled

bool

Returns

\Zend\I18n\View\Helper\AbstractTranslatorHelper

Set translation text domain

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

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::setTranslatorTextDomain()
inherited_from \Zend\Form\View\Helper\AbstractHelper::setTranslatorTextDomain()
inherited_from \Zend\Form\View\Helper\FormInput::setTranslatorTextDomain()

Parameters

$textDomain

string

Returns

\Zend\I18n\View\Helper\AbstractTranslatorHelper

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()
inherited_from \Zend\Form\View\Helper\AbstractHelper::setView()
inherited_from \Zend\Form\View\Helper\FormInput::setView()

Parameters

$view

\Zend\View\Renderer\RendererInterface

Returns

\Zend\View\Helper\AbstractHelper

Retrieve the doctype helper

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

inherited_from \Zend\Form\View\Helper\AbstractHelper::getDoctypeHelper()
inherited_from \Zend\Form\View\Helper\FormInput::getDoctypeHelper()

Returns

\Zend\View\Helper\Doctype

Retrieve the escapeHtmlAttr helper

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

inherited_from \Zend\Form\View\Helper\AbstractHelper::getEscapeHtmlAttrHelper()
inherited_from \Zend\Form\View\Helper\FormInput::getEscapeHtmlAttrHelper()

Returns

\Zend\View\Helper\EscapeHtmlAttr

Retrieve the escapeHtml helper

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

inherited_from \Zend\Form\View\Helper\AbstractHelper::getEscapeHtmlHelper()
inherited_from \Zend\Form\View\Helper\FormInput::getEscapeHtmlHelper()

Returns

\Zend\View\Helper\EscapeHtml

Determine input type to use

getType(\Zend\Form\ElementInterface $element) : string

Parameters

$element

\Zend\Form\ElementInterface

Returns

string

Prepare attributes for rendering

prepareAttributes(array $attributes) : array
Inherited

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

Removes any invalid attributes

inherited_from \Zend\Form\View\Helper\AbstractHelper::prepareAttributes()
inherited_from \Zend\Form\View\Helper\FormInput::prepareAttributes()

Parameters

$attributes

array

Returns

array

Prepare a boolean attribute value

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

Prepares the expected representation for the boolean attribute specified.

inherited_from \Zend\Form\View\Helper\AbstractHelper::prepareBooleanAttributeValue()
inherited_from \Zend\Form\View\Helper\FormInput::prepareBooleanAttributeValue()

Parameters

$attribute

string

$value

mixed

Returns

string

 Properties

 

Standard boolean attributes, with expected values for enabling/disabling

$booleanAttributes : array
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::$$booleanAttributes
inherited_from \Zend\Form\View\Helper\FormInput::$$booleanAttributes
 

$doctypeHelper

$doctypeHelper : \Zend\View\Helper\Doctype
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::$$doctypeHelper
inherited_from \Zend\Form\View\Helper\FormInput::$$doctypeHelper
 

$escapeHtmlAttrHelper

$escapeHtmlAttrHelper : \Zend\View\Helper\EscapeHtmlAttr
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::$$escapeHtmlAttrHelper
inherited_from \Zend\Form\View\Helper\FormInput::$$escapeHtmlAttrHelper
 

$escapeHtmlHelper

$escapeHtmlHelper : \Zend\View\Helper\EscapeHtml
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::$$escapeHtmlHelper
inherited_from \Zend\Form\View\Helper\FormInput::$$escapeHtmlHelper
 

Translatable attributes

$translatableAttributes : array
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::$$translatableAttributes
inherited_from \Zend\Form\View\Helper\FormInput::$$translatableAttributes
 

Translator (optional)

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

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$translator
inherited_from \Zend\Form\View\Helper\AbstractHelper::$$translator
inherited_from \Zend\Form\View\Helper\FormInput::$$translator
 

Whether translator should be used

$translatorEnabled : bool
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$translatorEnabled
inherited_from \Zend\Form\View\Helper\AbstractHelper::$$translatorEnabled
inherited_from \Zend\Form\View\Helper\FormInput::$$translatorEnabled
 

Translator text domain (optional)

$translatorTextDomain : string
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$translatorTextDomain
inherited_from \Zend\Form\View\Helper\AbstractHelper::$$translatorTextDomain
inherited_from \Zend\Form\View\Helper\FormInput::$$translatorTextDomain
 

Attributes globally valid for all tags

$validGlobalAttributes : array
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::$$validGlobalAttributes
inherited_from \Zend\Form\View\Helper\FormInput::$$validGlobalAttributes
 

Attributes valid for the input tag type="datetime"

$validTagAttributes : array

This should be overridden in extending classes

 

Valid values for the input type

$validTypes : array
Inherited

inherited_from \Zend\Form\View\Helper\FormInput::$$validTypes
 

View object instance

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

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