72930291611c5e64cc9922867a52247691cacf64
[core.git] / 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, 2009 - 2011 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 BaseCaptcha extends BaseHelper {
25         /**
26          * A helper instance for the form
27          */
28         private $helperInstance = null;
29
30         /**
31          * Protected constructor
32          *
33          * @param       $className      Name of the class
34          * @return      void
35          */
36         protected function __construct ($className) {
37                 // Call parent constructor
38                 parent::__construct($className);
39         }
40
41         /**
42          * Initializes the random number generator (RNG)
43          *
44          * @param       $extraInstance  An extra instance, just for better hash data
45          * @return      void
46          */
47         protected final function initializeRandomNumberGenerator (FrameworkInterface $extraInstance = null) {
48                 // Get an RNG from factory
49                 $this->setRngInstance(ObjectFactory::createObjectByConfiguredName('rng_class', array($extraInstance)));
50         }
51
52         /**
53          * Setter for helper instance
54          *
55          * @param       $helperInstance         An instance of a helper class
56          * @return      void
57          */
58         protected final function setHelperInstance (HelpableTemplate $helperInstance) {
59                 $this->helperInstance = $helperInstance;
60         }
61
62         /**
63          * Getter for helper instance
64          *
65          * @return      $helperInstance         An instance of a helper class
66          */
67         public final function getHelperInstance () {
68                 return $this->helperInstance;
69         }
70 }
71
72 // [EOF]
73 ?>