Zend Framework » \Zend\Form\View\Helper\Captcha\Image

Base functionality for all form view helpers

Methods

Invoke helper as functor

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

Inherited

Proxies to render().

inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::__invoke()

Parameters

$element

\Zend\Form\ElementInterface

Returns

string

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

Parameters

$attributes

array

Returns

string

Get position of captcha

getCaptchaPosition() : string

Inherited

inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::getCaptchaPosition()

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

Returns

string

Get separator for captcha and inputs

getSeparator() : string

Inherited

inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::getSeparator()

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

Returns

bool

Render the captcha

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

Parameters

$element

\Zend\Form\ElementInterface

Exceptions

`\Zend\Form\Exception\DomainException`

Returns

string

Set value for captchaPosition

setCaptchaPosition(mixed $captchaPosition) : \Zend\Form\View\Helper\Captcha\AbstractWord

Inherited

inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::setCaptchaPosition()

Parameters

$captchaPosition

mixed

Exceptions

`\Zend\Form\Exception\InvalidArgumentException`

Returns

\Zend\Form\View\Helper\Captcha\AbstractWord

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

Parameters

$encoding

string

Returns

\Zend\Form\View\Helper\AbstractHelper

Set separator string for captcha and inputs

setSeparator(string $separator) : \Zend\Form\View\Helper\Captcha\AbstractWord

Inherited

inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::setSeparator()

Parameters

$separator

string

Returns

\Zend\Form\View\Helper\Captcha\AbstractWord

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

Returns

\Zend\View\Helper\EscapeHtml

Determine input type to use

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

Inherited

inherited_from	\Zend\Form\View\Helper\FormInput::getType()
inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::getType()

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

Parameters

$attribute

string

$value

mixed

Returns

string

Render the hidden input with the captcha identifier

renderCaptchaHidden(\Zend\Captcha\AdapterInterface $captcha, array $attributes) : string

Inherited

inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::renderCaptchaHidden()

Parameters

$captcha

\Zend\Captcha\AdapterInterface

$attributes

array

Returns

string

Render the input for capturing the captcha value from the client

renderCaptchaInput(\Zend\Captcha\AdapterInterface $captcha, array $attributes) : string

Inherited

inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::renderCaptchaInput()

Parameters

$captcha

\Zend\Captcha\AdapterInterface

$attributes

array

Returns

string

Render captcha form elements for the given element

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

Inherited

Creates and returns: - Hidden input with captcha identifier (name[id]) - Text input for entering captcha value (name[input])

More specific renderers will consume this and render it.

inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::renderCaptchaInputs()

Parameters

$element

\Zend\Form\ElementInterface

Exceptions

`\Zend\Form\Exception\DomainException`

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

$captchaPosition

$captchaPosition : string

Inherited

inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::$$captchaPosition

$doctypeHelper

$doctypeHelper : \Zend\View\Helper\Doctype

Inherited

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

$escapeHtmlAttrHelper

$escapeHtmlAttrHelper : \Zend\View\Helper\EscapeHtmlAttr

Inherited

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

$escapeHtmlHelper

$escapeHtmlHelper : \Zend\View\Helper\EscapeHtml

Inherited

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

$inputHelper

$inputHelper : \Zend\Form\View\Helper\FormInput

Inherited

inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::$$inputHelper

Separator string for captcha and inputs

$separator : string

Inherited

inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::$$separator

Translatable attributes

$translatableAttributes : array

Inherited

inherited_from	\Zend\Form\View\Helper\AbstractHelper::$$translatableAttributes
inherited_from	\Zend\Form\View\Helper\FormInput::$$translatableAttributes
inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::$$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
inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::$$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
inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::$$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
inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::$$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
inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::$$validGlobalAttributes

Attributes valid for the input tag

$validTagAttributes : array

Inherited

This should be overridden in extending classes

inherited_from	\Zend\Form\View\Helper\FormInput::$$validTagAttributes
inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::$$validTagAttributes

Valid values for the input type

$validTypes : array

Inherited

inherited_from	\Zend\Form\View\Helper\FormInput::$$validTypes
inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::$$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
inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::$$view

Constants

CAPTCHA_APPEND

CAPTCHA_APPEND

Inherited

inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::CAPTCHA_APPEND

CAPTCHA_PREPEND

CAPTCHA_PREPEND

Inherited

inherited_from	\Zend\Form\View\Helper\Captcha\AbstractWord::CAPTCHA_PREPEND