Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Generic captcha element
This element allows to insert CAPTCHA into the form in order to validate that human is submitting the form. The actual logic is contained in the captcha adapter.

__construct(
string|array|\Zend_Config $spec, $options
=
null
)
:
void
Constructor
$spec may be: - string: name of element - array: options with which to configure element - Zend_Config: Zend_Config with options for configuring element
Name | Type | Description |
---|---|---|
$spec | string|array|\Zend_Config | |
$options |

addPrefixPath(
string $prefix, string $path, string $type
=
null
)
:
\Zend_Form_Element
Add prefix path for plugin loader for captcha adapters
This method handles the captcha type, the rest is handled by the parent
Name | Type | Description |
---|---|---|
$prefix | string | |
$path | string | |
$type | string |
Type | Description |
---|---|
\Zend_Form_Element |

getCaptcha(
)
:
\Zend_Captcha_Adapter
Get captcha adapter
Type | Description |
---|---|
\Zend_Captcha_Adapter |

getPluginLoader(
string $type
)
:
\Zend_Loader_PluginLoader
Retrieve plugin loader for validator or filter chain
Support for plugin loader for Captcha adapters
Name | Type | Description |
---|---|---|
$type | string |
Type | Description |
---|---|
\Zend_Loader_PluginLoader |
Exception | Description |
---|---|
\Zend_Loader_Exception | on invalid type. |

isValid(
mixed $value, mixed $context
=
null
)
:
boolean
Is the captcha valid?
Name | Type | Description |
---|---|---|
$value | mixed | |
$context | mixed |
Type | Description |
---|---|
boolean |

loadDefaultDecorators(
)
:
\Zend_Form_Element_Captcha
Load default decorators
Type | Description |
---|---|
\Zend_Form_Element_Captcha |

setCaptcha(
string|array|\Zend_Captcha_Adapter $captcha, array $options
=
array()
)
:
void
Set captcha adapter
Name | Type | Description |
---|---|---|
$captcha | string|array|\Zend_Captcha_Adapter | |
$options | array |

setOptions(
array $options
)
:
\Zend_Form_Element_Captcha
Set options
Overrides to allow passing captcha options
Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Form_Element_Captcha |