CommunityID/libs/Zend/Captcha/Adapter.php

77 lines
2.0 KiB
PHP

<?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
* @package Zend_Captcha
* @subpackage Adapter
* @copyright Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
/** Zend_Validate_Interface */
require_once 'Zend/Validate/Interface.php';
/**
* Generic Captcha adapter interface
*
* Each specific captcha implementation should implement this interface
*
* @category Zend
* @package Zend_Captcha
* @subpackage Adapter
* @copyright Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id: $
*/
interface Zend_Captcha_Adapter extends Zend_Validate_Interface
{
/**
* Generate a new captcha
*
* @return string new captcha ID
*/
public function generate();
/**
* Display the captcha
*
* @param Zend_View_Interface $view
* @param mixed $element
* @return string
*/
public function render(Zend_View_Interface $view = null, $element = null);
/**
* Set captcha name
*
* @param string $name
* @return Zend_Captcha_Adapter
*/
public function setName($name);
/**
* Get captcha name
*
* @return string
*/
public function getName();
/**
* Get optional private decorator for this captcha type
*
* @return Zend_Form_Decorator_Interface|string
*/
public function getDecorator();
}