API Documentation

Captcha/Adapter.php

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.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Captcha  
subpackage
Adapter  

\Zend_Captcha_Adapter

Generic Captcha adapter interface

Each specific captcha implementation should implement this interface

Extends from
\Zend_Validate_Interface
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Captcha  
subpackage
Adapter  
version
$Id: Adapter.php 23775 2011-03-01 17:25:24Z ralph $  

Methods

methodpublicgenerate( ) : string

Generate a new captcha

Returns
Type Description
string new captcha ID
methodpublicgetDecorator( ) : \Zend_Form_Decorator_Interface|string

Get optional private decorator for this captcha type

Returns
Type Description
\Zend_Form_Decorator_Interfacestring
methodpublicgetMessages( ) : array

Returns an array of messages that explain why the most recent isValid() call returned false. The array keys are validation failure message identifiers, and the array values are the corresponding human-readable message strings.

Inherited from: \Zend_Validate_Interface::getMessages()

If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.

Returns
Type Description
array
methodpublicgetName( ) : string

Get captcha name

Returns
Type Description
string
methodpublicisValid( mixed $value ) : boolean

Returns 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.

Parameters
Name Type Description
$value mixed
Returns
Type Description
boolean
Throws
Exception Description
\Zend_Validate_Exception If validation of $value is impossible
methodpublicrender( \Zend_View_Interface $view = null, mixed $element = null ) : string

Display the captcha

Parameters
Name Type Description
$view \Zend_View_Interface
$element mixed
Returns
Type Description
string
methodpublicsetName( string $name ) : \Zend_Captcha_Adapter

Set captcha name

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Captcha_Adapter
Documentation was generated by DocBlox 0.13.3.