]> git.mxchange.org Git - core.git/blob - framework/main/classes/stacker/class_
Some updates:
[core.git] / framework / main / classes / stacker / class_
1 <?php
2 // Own namespace
3 namespace CoreFramework\Stacker\!!!;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Stacker\BaseStacker;
7 use Org\Mxchange\CoreFramework\Stacker\Stackable;
8
9 /**
10  * A ??? Stacker class
11  *
12  * @author              Roland Haeder <webmaster@ship-simu.org>
13  * @version             0.0.0
14 <<<<<<< HEAD:framework/main/classes/stacker/class_
15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 =======
17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
18 >>>>>>> Some updates::inc/main/classes/stacker/class_
19  * @license             GNU GPL 3.0 or any newer version
20  * @link                http://www.ship-simu.org
21  *
22  * This program is free software: you can redistribute it and/or modify
23  * it under the terms of the GNU General Public License as published by
24  * the Free Software Foundation, either version 3 of the License, or
25  * (at your option) any later version.
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30  * GNU General Public License for more details.
31  *
32  * You should have received a copy of the GNU General Public License
33  * along with this program. If not, see <http://www.gnu.org/licenses/>.
34  */
35 class ???Stacker extends BaseStacker implements Stackable {
36         /**
37          * Protected constructor
38          *
39          * @return      void
40          */
41         protected function __construct () {
42                 // Call parent constructor
43                 parent::__construct(__CLASS__);
44         }
45
46         /**
47          * Creates an instance of the class Stacker and prepares it for usage
48          *
49          * @param       $appInstance    A manageable application
50          * @return      $stackInstance  An instance of ???Stacker
51          */
52         public final static function create???Stacker (ManageableApplication $appInstance) {
53                 // Get a new instance
54                 $stackInstance = new ???Stacker();
55
56                 // Init generic stacker
57                 $stackInstance->initStack('generic');
58
59                 // Return the prepared instance
60                 return $stackInstance;
61         }
62
63         /**
64          * Pushs a value on a named stacker
65          *
66          * @param       $stackerName    Name of the stack
67          * @param       $value                  Value to push on it
68          * @return      void
69          * @throws      StackerFullException    If the stack is full
70          */
71         public function pushNamed ($stackerName, $value) {
72                 $this->partialStub('stackerName=' . $stackerName . ',value[' . gettype($value) . ']=' . $value);
73         }
74
75         /**
76          * 'Pops' a value from a named stacker
77          *
78          * @param       $stackerName    Name of the stack
79          * @return      void
80          * @throws      NoStackerException      If the named stacker was not found
81          * @throws      EmptyStackerException   If the named stacker is empty
82          */
83         public function popNamed ($stackerName) {
84                 $this->partialStub('stackerName=' . $stackerName);
85         }
86
87         /**
88          * Get value from named stacker
89          *
90          * @param       $stackerName    Name of the stack
91          * @return      $value                  Value of last added value
92          * @throws      NoStackerException      If the named stacker was not found
93          * @throws      EmptyStackerException   If the named stacker is empty
94          */
95         public function getNamed ($stackerName) {
96                 $this->partialStub('stackerName=' . $stackerName);
97         }
98
99 }