2c765ffc623c1a00c94ac70101dcfd20a6534765
[core.git] / framework / main / classes / visitor / class_BaseVisitor.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Visitor;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
7
8 /**
9  * A general visitor class
10  *
11  * @author              Roland Haeder <webmaster@shipsimu.org>
12  * @version             0.0.0
13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14  * @license             GNU GPL 3.0 or any newer version
15  * @link                http://www.shipsimu.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 BaseVisitor extends BaseFrameworkSystem {
31         /**
32          * Mode of the visitor (the first word of the concrete class' name)
33          */
34         private $visitorMode = 'invalid';
35
36         /**
37          * Protected constructor
38          *
39          * @param       $className      Name of the class
40          * @return      void
41          */
42         protected function __construct ($className) {
43                 // Call parent constructor
44                 parent::__construct($className);
45         }
46
47         /**
48          * Setter for visitor mode
49          *
50          * @param       $visitorMode    New visitor mode to set
51          * @return      void
52          */
53         protected final function setVisitorMode ($visitorMode) {
54                 $this->visitorMode = (string) $visitorMode;
55         }
56
57         /**
58          * Getter for visitor mode
59          *
60          * @return      $visitorMode    New visitor mode to set
61          */
62         public final function getVisitorMode () {
63                 return $this->visitorMode;
64         }
65
66 }