API Documentation

Zend/Captcha/Adapter.php

Show: inherited
    Table of Contents

    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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  
    Package
    Zend_Captcha  
    Subpackage
    Adapter  

    \Zend_Captcha_Adapter

    Package: Zend\Captcha\Adapter

    Generic Captcha adapter interface

    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 24594 2012-01-05 21:27:01Z matthew $  

    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_Interface|string
    methodpublicgetName( ) : string

    Get captcha name

    Returns
    Type Description
    string
    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.15.1.