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