API Documentation

Captcha/Adapter.php

Includes Interfaces
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Captcha
subpackage
Adapter
Interfaces
Zend_Captcha_Adapter

Description

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.

Zend_Captcha_Adapter

Extends from
Zend_Validate_Interface
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Captcha
subpackage
Adapter
version
$Id: Adapter.php 20096 2010-01-06 02:05:09Z bkarwin $
Methods
generate
render
setName
getName
getDecorator

Description

Generic Captcha adapter interface

Each specific captcha implementation should implement this interface

Methods

generate

generate( ) : string

Generate a new captcha

Output
string
new captcha ID
Details
visibility
public
final
false
static
false

getDecorator

getDecorator( ) : Zend_Form_Decorator_Interface|string

Get optional private decorator for this captcha type

Details
visibility
public
final
false
static
false

getName

getName( ) : string

Get captcha name

Output
string
Details
visibility
public
final
false
static
false

render

render( Zend_View_Interface $view = null, mixed $element = null ) : string

Display the captcha

Arguments
$view
Zend_View_Interface
$element
mixed
Output
string
Details
visibility
public
final
false
static
false

setName

setName( string $name ) : Zend_Captcha_Adapter

Set captcha name

Arguments
$name
string
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.