framework/main/traits/state/class_StateableTrait.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Traits\State;
   4
   5 use Org\Mxchange\CoreFramework\State\Stateable;
   6
   7 /**
   8  * A trait for states
   9  *
  10  * @author              Roland Haeder <webmaster@shipsimu.org>
  11  * @version             0.0.0
  12  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
  13  * @license             GNU GPL 3.0 or any newer version
  14  * @link                http://www.shipsimu.org
  15  *
  16  * This program is free software: you can redistribute it and/or modify
  17  * it under the terms of the GNU General Public License as published by
  18  * the Free Software Foundation, either version 3 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License
  27  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  28  */
  29 trait StateableTrait {
  30         /**
  31          * State instance
  32          */
  33         private $stateInstance = NULL;
  34
  35         /**
  36          * Setter for state instance
  37          *
  38          * @param       $stateInstance  A Stateable instance
  39          * @return      void
  40          */
  41         public final function setStateInstance (Stateable $stateInstance) {
  42                 $this->stateInstance = $stateInstance;
  43         }
  44
  45         /**
  46          * Getter for state instance
  47          *
  48          * @return      $stateInstance  A Stateable instance
  49          */
  50         public final function getStateInstance () {
  51                 return $this->stateInstance;
  52         }
  53
  54 }