Captcha/Adapter.php
inheritedLICENSE
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Captcha
- Subpackage
- Adapter
\Zend_Captcha_Adapter
Each specific captcha implementation should implement this interface
- Parent(s)
- \Zend_Validate_Interface
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id: Adapter.php 24593 2012-01-05 20:35:02Z matthew $
Methods
generate() : stringGenerate a new captcha
| Type | Description |
|---|---|
| string | new captcha ID |
getDecorator() : \Zend_Form_Decorator_Interface | stringGet optional private decorator for this captcha type
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Interface | string |
getMessages() : arrayReturns an array of messages that explain why the most recent isValid() call returned false.
Inherited from: \Zend_Validate_Interface::getMessages()The array keys are validation failure message identifiers, and the array values are the corresponding human-readable message strings.
If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.
| Type | Description |
|---|---|
| array |
getName() : stringGet captcha name
| Type | Description |
|---|---|
| string |
isValid(mixed $value) : booleanReturns true if and only if $value meets the validation requirements
Inherited from: \Zend_Validate_Interface::isValid()If $value fails validation, then this method returns false, and getMessages() will return an array of messages that explain why the validation failed.
| Name | Type | Description |
|---|---|---|
| $value | mixed |
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Validate_Exception | If validation of $value is impossible |
render(\Zend_View_Interface $view = null, mixed $element = null) : stringDisplay the captcha
| Name | Type | Description |
|---|---|---|
| $view | \Zend_View_Interface | |
| $element | mixed |
| Type | Description |
|---|---|
| string |
setName(string $name) : \Zend_Captcha_AdapterSet captcha name
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Captcha_Adapter |