framework/main/classes/helper/captcha/class_

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