inc/main/interfaces/resolver/state/class_StateResolver.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Resolver\State;
   4
   5 // Import framework stuff
   6 use CoreFramework\Resolver\Resolver;
   7
   8 /**
   9  * An instance for state resolver classes
  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 interface StateResolver extends Resolver {
  31         /**
  32          * Returns an state instance for a given package raw data and socket resource
  33          *
  34          * @param       $helperInstance         An instance of a ConnectionHelper class
  35          * @param       $packageData            Raw package data
  36          * @param       $socketResource         A valid socket resource
  37          * @return      $stateInstance          An instance of the resolved state
  38          */
  39         static function resolveStateByPackage (ConnectionHelper $helperInstance, array $packageData, $socketResource);
  40
  41         /**
  42          * Checks whether the given state is valid
  43          *
  44          * @param       $stateName      The default state we shall execute
  45          * @return      $isValid        Whether the given state is valid
  46          * @throws      EmptyVariableException  Thrown if given state is not set
  47          */
  48         function isStateValid ($stateName);
  49
  50 }