framework/main/classes/helper/captcha/class_

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