inc/classes/main/helper/captcha/class_

   1 <?php
   2 /**
   3  * A solveable CAPTCHA
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class ???Captcha extends BaseCaptcha implements SolveableCaptcha {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this captcha class
  37          *
  38          * @param       $templateInstance       An instance of a template engine
  39          * @param       $extraInstance          An extra instance, just for better hash data
  40          * @return      $captchaInstance        An instance of this captcha class
  41          */
  42         public final static function create???Captcha (CompileableTemplate $templateInstance, FrameworkInterface $extraInstance = null) {
  43                 // Get a new instance
  44                 $captchaInstance = new ???Captcha();
  45
  46                 // Set template instance
  47                 $captchaInstance->setTemplateInstance($templateInstance);
  48
  49                 // Initialize the RNG
  50                 $captchaInstance->initializeRandomNumberGenerator($extraInstance);
  51
  52                 // Return the instance
  53                 return $captchaInstance;
  54         }
  55
  56         /**
  57          * Initiates the CAPTCHA
  58          *
  59          * @return      void
  60          * @todo        0% done
  61          */
  62         public function initiateCaptcha () {
  63                 $this->partialStub("Please implement this method.");
  64         }
  65
  66         /**
  67          * Render the CAPTCHA code
  68          *
  69          * @return      void
  70          * @todo        0% done
  71          */
  72         public function renderCode () {
  73                 $this->partialStub("Please implement this method.");
  74         }
  75 }
  76
  77 // [EOF]
  78 ?>