web/Zend/Captcha/Adapter.php
changeset 0 4eba9c11703f
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/web/Zend/Captcha/Adapter.php	Mon Dec 13 18:29:26 2010 +0100
@@ -0,0 +1,76 @@
+<?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-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+
+/** @see 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-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @version    $Id: Adapter.php 20096 2010-01-06 02:05:09Z bkarwin $
+ */
+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();
+}