Captcha/Adapter.php

Show: PublicProtectedPrivateinherited
    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 24593 2012-01-05 20:35:02Z matthew $  

    Methods

    methodpublicgenerate() : string

    Generate a new captcha

    Returns
    TypeDescription
    stringnew captcha ID
    methodpublicgetDecorator() : \Zend_Form_Decorator_Interface | string

    Get optional private decorator for this captcha type

    Returns
    TypeDescription
    \Zend_Form_Decorator_Interface | string
    methodpublicgetMessages() : array
    inherited

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

    Returns
    TypeDescription
    array
    methodpublicgetName() : string

    Get captcha name

    Returns
    TypeDescription
    string
    methodpublicisValid(mixed $value) : boolean
    inherited

    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
    NameTypeDescription
    $valuemixed
    Returns
    TypeDescription
    boolean
    Throws
    ExceptionDescription
    \Zend_Validate_ExceptionIf validation of $value is impossible
    methodpublicrender(\Zend_View_Interface $view = null, mixed $element = null) : string

    Display the captcha

    Parameters
    NameTypeDescription
    $view\Zend_View_Interface
    $elementmixed
    Returns
    TypeDescription
    string
    methodpublicsetName(string $name) : \Zend_Captcha_Adapter

    Set captcha name

    Parameters
    NameTypeDescription
    $namestring
    Returns
    TypeDescription
    \Zend_Captcha_Adapter
    Documentation was generated by phpDocumentor 2.0.0a12.