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

   1 <?php
   2 /**
   3  * A general captcha
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   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 BaseCaptcha extends BaseHelper {
  25         /**
  26          * A helper instance for the form
  27          */
  28         private $helperInstance = null;
  29
  30         /**
  31          * Instance of an RNG
  32          */
  33         private $rngInstance = null;
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @param       $className      Name of the class
  39          * @return      void
  40          */
  41         protected function __construct ($className) {
  42                 // Call parent constructor
  43                 parent::__construct($className);
  44
  45                 // Clean up a little
  46                 $this->removeNumberFormaters();
  47                 $this->removeSystemArray();
  48         }
  49
  50         /**
  51          * Initializes the random number generator (RNG)
  52          *
  53          * @param       $extraInstance  An extra instance, just for better hash data
  54          * @return      void
  55          */
  56         protected final function initializeRandomNumberGenerator (FrameworkInterface $extraInstance = null) {
  57                 // Get an RNG from factory
  58                 $this->rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class', array($extraInstance));
  59         }
  60
  61         /**
  62          * Getter for RNG instance
  63          *
  64          * @return      $rngInstance    An instance of a random number generator (RNG)
  65          */
  66         public final function getRngInstance () {
  67                 return $this->rngInstance;
  68         }
  69
  70         /**
  71          * Setter for helper instance
  72          *
  73          * @param       $helperInstance         An instance of a helper class
  74          * @return      void
  75          */
  76         protected final function setHelperInstance (HelpableTemplate $helperInstance) {
  77                 $this->helperInstance = $helperInstance;
  78         }
  79
  80         /**
  81          * Getter for helper instance
  82          *
  83          * @return      $helperInstance         An instance of a helper class
  84          */
  85         public final function getHelperInstance () {
  86                 return $this->helperInstance;
  87         }
  88 }
  89
  90 // [EOF]
  91 ?>