Zend Framework » \Zend\Form\View\Helper\FormCollection

Base functionality for all form view helpers

Methods

Invoke helper as function

__invoke(\Zend\Form\ElementInterface $element, bool $wrap) : string | \Zend\Form\View\Helper\FormCollection

Proxies to render().

Parameters

$element

\Zend\Form\ElementInterfacenull

$wrap

bool

Returns

string\Zend\Form\View\Helper\FormCollection

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

Gets the name of the view helper that should be used to render sub elements.

getDefaultElementHelper() : string

Returns

string

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 the wrapper for the label

getLabelWrapper() : string

Returns

string

Ge the wrapper for the template

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

Get the wrapper for the collection

getWrapper() : string

Returns

string

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 collection by iterating through all fieldsets and elements

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

Parameters

$element

\Zend\Form\ElementInterface

Returns

string

Only render a template

renderTemplate(\Zend\Form\Element\Collection $collection) : string

Parameters

$collection

\Zend\Form\Element\Collection

Returns

string

Sets the name of the view helper that should be used to render sub elements.

setDefaultElementHelper(string $defaultSubHelper) : \Zend\Form\View\Helper\FormCollection

Parameters

$defaultSubHelper

string

The name of the view helper to set.

Returns

\Zend\Form\View\Helper\FormCollection

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

Sets the element helper that should be used by this collection.

setElementHelper(\Zend\Form\View\Helper\AbstractHelper $elementHelper) : \Zend\Form\View\Helper\FormCollection

Parameters

$elementHelper

\Zend\Form\View\Helper\AbstractHelper

The element helper to use.

Returns

\Zend\Form\View\Helper\FormCollection

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

Sets the fieldset helper that should be used by this collection.

setFieldsetHelper(\Zend\Form\View\Helper\AbstractHelper $fieldsetHelper) : \Zend\Form\View\Helper\FormCollection

Parameters

$fieldsetHelper

\Zend\Form\View\Helper\AbstractHelper

The fieldset helper to use.

Returns

\Zend\Form\View\Helper\FormCollection

Set the label-wrapper The string will be passed through sprintf with the label as single parameter This defaults to '<legend>%s</legend>'

setLabelWrapper(string $labelWrapper) : \Zend\Form\View\Helper\self

Parameters

$labelWrapper

string

Returns

\Zend\Form\View\Helper\self

If set to true, collections are automatically wrapped around a fieldset

setShouldWrap(bool $wrap) : \Zend\Form\View\Helper\FormCollection

Parameters

$wrap

bool

Returns

\Zend\Form\View\Helper\FormCollection

Set the string where the template will be inserted into

setTemplateWrapper(string $templateWrapper) : \Zend\Form\View\Helper\self

This string will be passed through sprintf and has the template as single parameter

THis defaults to ''

Parameters

$templateWrapper

string

Returns

\Zend\Form\View\Helper\self

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

Set the wrapper for this collection

setWrapper(string $wrapper) : \Zend\Form\View\Helper\self

The string given will be passed through sprintf with the following three replacements:

The content of the collection
The label of the collection. If no label is given this will be an empty string
The template span-tag. This might also be an empty string

The preset default is

%2$s%1$s%3$s

Parameters

$wrapper

string

Returns

\Zend\Form\View\Helper\self

Get wrapped

shouldWrap() : bool

Returns

bool

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 element helper.

getElementHelper() : \Zend\Form\View\Helper\AbstractHelper

Exceptions

`\RuntimeException`

Returns

\Zend\Form\View\Helper\AbstractHelper

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

Retrieve the fieldset helper.

getFieldsetHelper() : \Zend\Form\View\Helper\FormCollection

Returns

\Zend\Form\View\Helper\FormCollection

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

The name of the default view helper that is used to render sub elements.

$defaultElementHelper : string

$doctypeHelper

$doctypeHelper : \Zend\View\Helper\Doctype

Inherited

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

The view helper used to render sub elements.

$elementHelper : \Zend\Form\View\Helper\AbstractHelper

$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

The view helper used to render sub fieldsets.

$fieldsetHelper : \Zend\Form\View\Helper\AbstractHelper

This is the default label-wrapper

$labelWrapper : string

If set to true, collections are automatically wrapped around a fieldset

$shouldWrap : bool

Where shall the template-data be inserted into

$templateWrapper : string

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

This is the default wrapper that the collection is wrapped into

$wrapper : string