X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=framework%2Fmain%2Finterfaces%2Fstacker%2Fclass_Stackable.php;h=4881c6f6d9565641d2ba15be6e2f9d317ecae34f;hp=aebbd9f878f257f2612960b95b6aa05dd3874925;hb=refs%2Fheads%2Fmaster;hpb=2c3a0173e6dbfab3093b01643dc03110ddb4538b diff --git a/framework/main/interfaces/stacker/class_Stackable.php b/framework/main/interfaces/stacker/class_Stackable.php index aebbd9f8..4881c6f6 100644 --- a/framework/main/interfaces/stacker/class_Stackable.php +++ b/framework/main/interfaces/stacker/class_Stackable.php @@ -1,6 +1,6 @@ * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.shipsimu.org * @@ -34,7 +34,7 @@ interface Stackable extends FrameworkInterface { * @param $stackerName Name of the stacker * @param $value Value to push on it * @return void - * @throws StackerFullException If the stacker is full + * @throws BadMethodCallException If the stacker is full */ function pushNamed (string $stackerName, $value); @@ -44,7 +44,7 @@ interface Stackable extends FrameworkInterface { * @param $stackerName Name of the stacker * @return $value Value of the current stack entry * @throws BadMethodCallException If the named stacker was not found - * @throws EmptyStackerException If the named stacker is empty + * @throws BadMethodCallException If the named stacker is empty */ function popNamed (string $stackerName); @@ -54,7 +54,7 @@ interface Stackable extends FrameworkInterface { * @param $stackerName Name of the stacker * @return $value Value of last added value * @throws BadMethodCallException If the named stacker was not found - * @throws EmptyStackerException If the named stacker is empty + * @throws BadMethodCallException If the named stacker is empty */ function getNamed (string $stackerName); @@ -75,4 +75,30 @@ interface Stackable extends FrameworkInterface { */ function isStackEmpty (string $stackerName); + /** + * Initializes given stacker + * + * @param $stackerName Name of the stack + * @param $forceReInit Force re-initialization + * @return void + * @throws UnsupportedOperationException This method is not (and maybe never will be) supported + */ + function initStack (string $stackerName, bool $forceReInit = false); + + /** + * Initializes all stacks + * + * @return void + * @throws UnsupportedOperationException This method is not (and maybe never will be) supported + */ + function initStacks (array $stacks, bool $forceReInit = false); + + /** + * Getter for size of given stack (array count) + * + * @param $stackerName Name of the stack + * @return $count Size of stack (array count) + */ + function getStackCount (string $stackerName); + }