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

   1 <?php
   2 /**
   3  * An instance for state resolver classes
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 interface StateResolver extends Resolver {
  25         /**
  26          * Returns an state instance for a given package raw data and socket resource
  27          *
  28          * @param       $helperInstance         An instance of a ConnectionHelper class
  29          * @param       $packageData            Raw package data
  30          * @param       $socketResource         A valid socket resource
  31          * @return      $stateInstance          An instance of the resolved state
  32          */
  33         static function resolveStateByPackage (ConnectionHelper $helperInstance, array $packageData, $socketResource);
  34
  35         /**
  36          * Checks whether the given state is valid
  37          *
  38          * @param       $stateName      The default state we shall execute
  39          * @return      $isValid        Whether the given state is valid
  40          * @throws      EmptyVariableException  Thrown if given state is not set
  41          */
  42         function isStateValid ($stateName);
  43 }
  44
  45 // [EOF]
  46 ?>