interface/modules/zend_modules/library/Zend/Captcha/AdapterInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Captcha;
  11
  12 use Zend\Validator\ValidatorInterface;
  13
  14 /**
  15  * Generic Captcha adapter interface
  16  *
  17  * Each specific captcha implementation should implement this interface
  18  */
  19 interface AdapterInterface extends ValidatorInterface
  20 {
  21     /**
  22      * Generate a new captcha
  23      *
  24      * @return string new captcha ID
  25      */
  26     public function generate();
  27
  28     /**
  29      * Set captcha name
  30      *
  31      * @param  string $name
  32      * @return AdapterInterface
  33      */
  34     public function setName($name);
  35
  36     /**
  37      * Get captcha name
  38      *
  39      * @return string
  40      */
  41     public function getName();
  42
  43     /**
  44      * Get helper name to use when rendering this captcha type
  45      *
  46      * @return string
  47      */
  48     public function getHelperName();
  49 }