Zend Framework » \Zend\Form\View\Helper\FormMonthSelect

Base functionality for all form view helpers

Methods

__construct()

__construct()

Exceptions

`\Zend\Form\Exception\ExtensionNotLoadedException`	if ext/intl is not present

Invoke helper as function

__invoke(\Zend\Form\ElementInterface $element, int $dateType, null | string $locale) : \Zend\Form\View\Helper\FormDateSelect

Proxies to render().

Parameters

$element

\Zend\Form\ElementInterface

$dateType

int

$locale

nullstring

Returns

\Zend\Form\View\Helper\FormDateSelect

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

Parameters

$attributes

array

Returns

string

Get date formatter

getDateType() : int

Returns

int

Get value for doctype

getDoctype() : string

Inherited

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

Returns

string

Get character encoding

getEncoding() : string

Inherited

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

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

Returns

string

Get locale

getLocale() : string

Returns

string

Retrieve pattern to use for Date rendering

getPattern() : string

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

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

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

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

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

Returns

bool

Render a month element that is composed of two selects

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

Parameters

$element

\Zend\Form\ElementInterface

Exceptions

`\Zend\Form\Exception\InvalidArgumentException`
`\Zend\Form\Exception\DomainException`

Returns

string

Set date formatter

setDateType(int $dateType) : \Zend\Form\View\Helper\FormDateSelect

Parameters

$dateType

int

Returns

\Zend\Form\View\Helper\FormDateSelect

Set value for doctype

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

Inherited

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

Parameters

$encoding

string

Returns

\Zend\Form\View\Helper\AbstractHelper

Set locale

setLocale(string $locale) : \Zend\Form\View\Helper\FormDateSelect

Parameters

$locale

string

Returns

\Zend\Form\View\Helper\FormDateSelect

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

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

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

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

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

Returns

\Zend\View\Helper\Doctype

Retrieve the escapeHtmlAttr helper

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

Inherited

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

Returns

\Zend\View\Helper\EscapeHtmlAttr

Retrieve the escapeHtml helper

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

Inherited

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

Returns

\Zend\View\Helper\EscapeHtml

Create a key => value options for months

getMonthsOptions(string $pattern) : array

Parameters

$pattern

string

Pattern to use for months

Returns

array

Retrieve the FormSelect helper

getSelectElementHelper() : \Zend\Form\View\Helper\FormSelect

Returns

\Zend\Form\View\Helper\FormSelect

Create a key => value options for years NOTE: we don't use a pattern for years, as years written as two digits can lead to hard to read date for users, so we only use four digits years

getYearsOptions(int $minYear, int $maxYear) : array

Parameters

$minYear

int

$maxYear

int

Returns

array

Parse the pattern

parsePattern(bool $renderDelimiters) : array

Parameters

$renderDelimiters

bool

Returns

array

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

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

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

Date formatter to use

$dateType : int

$doctypeHelper

$doctypeHelper : \Zend\View\Helper\Doctype

Inherited

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

$escapeHtmlAttrHelper

$escapeHtmlAttrHelper : \Zend\View\Helper\EscapeHtmlAttr

Inherited

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

$escapeHtmlHelper

$escapeHtmlHelper : \Zend\View\Helper\EscapeHtml

Inherited

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

Locale to use

$locale : string

Pattern to use for Date rendering

$pattern : string

FormSelect helper

$selectHelper : \Zend\Form\View\Helper\FormSelect

Translatable attributes

$translatableAttributes : array

Inherited

inherited_from	\Zend\Form\View\Helper\AbstractHelper::$$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

Whether translator should be used

$translatorEnabled : bool

Inherited

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

Translator text domain (optional)

$translatorTextDomain : string

Inherited

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

Attributes globally valid for all tags

$validGlobalAttributes : array

Inherited

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

Attributes valid for the tag represented by this helper

$validTagAttributes : array

Inherited

This should be overridden in extending classes

inherited_from	\Zend\Form\View\Helper\AbstractHelper::$$validTagAttributes

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