framework/main/classes/helper/captcha/class_BaseCaptcha.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Helper\Captcha;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Crypto\RandomNumber\RandomNumberGenerator;
   7 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
   8 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
   9 use Org\Mxchange\CoreFramework\Helper\BaseHelper;
  10
  11 /**
  12  * A general captcha
  13  *
  14  * @author              Roland Haeder <webmaster@shipsimu.org>
  15  * @version             0.0.0
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
  17  * @license             GNU GPL 3.0 or any newer version
  18  * @link                http://www.shipsimu.org
  19  *
  20  * This program is free software: you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation, either version 3 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  32  */
  33 abstract class BaseCaptcha extends BaseHelper {
  34         /**
  35          * Instance of a RNG
  36          */
  37         private $rngInstance = NULL;
  38
  39         /**
  40          * Protected constructor
  41          *
  42          * @param       $className      Name of the class
  43          * @return      void
  44          */
  45         protected function __construct (string $className) {
  46                 // Call parent constructor
  47                 parent::__construct($className);
  48         }
  49
  50         /**
  51          * Setter for RNG instance
  52          *
  53          * @param       $rngInstance    An instance of a random number generator (RNG)
  54          * @return      void
  55          */
  56         protected final function setRngInstance (RandomNumberGenerator $rngInstance) {
  57                 $this->rngInstance = $rngInstance;
  58         }
  59
  60         /**
  61          * Getter for RNG instance
  62          *
  63          * @return      $rngInstance    An instance of a random number generator (RNG)
  64          */
  65         public final function getRngInstance () {
  66                 return $this->rngInstance;
  67         }
  68
  69         /**
  70          * Initializes the random number generator (RNG)
  71          *
  72          * @param       $extraInstance  An extra instance, just for better hash data
  73          * @return      void
  74          */
  75         protected final function initializeRandomNumberGenerator (FrameworkInterface $extraInstance = NULL) {
  76                 // Get an RNG from factory
  77                 $this->setRngInstance(ObjectFactory::createObjectByConfiguredName('rng_class', array($extraInstance)));
  78         }
  79
  80 }