inc/main/classes/resolver/action/class_BaseActionResolver.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Resolver\Action;
   4
   5 // Import framework stuff
   6 use CoreFramework\Factory\ObjectFactory;
   7
   8 /**
   9  * A generic action resolver class
  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 class BaseActionResolver extends BaseResolver {
  31         /**
  32          * Validated action name
  33          */
  34         private $actionName = '';
  35
  36         /**
  37          * Protected constructor
  38          *
  39          * @param       $className      Name of the class
  40          * @return      void
  41          */
  42         protected function __construct ($className) {
  43                 // Call parent constructor
  44                 parent::__construct($className);
  45         }
  46
  47         /**
  48          * Setter for action name
  49          *
  50          * @param       $actionName     Last validated action name
  51          * @return      void
  52          */
  53         protected final function setActionName ($actionName) {
  54                 $this->actionName = (string) $actionName;
  55         }
  56
  57         /**
  58          * Getter for action name
  59          *
  60          * @return      $actionName     Last validated action name
  61          */
  62         public final function getActionName () {
  63                 return $this->actionName;
  64         }
  65
  66         /**
  67          * Checks whether the given action is valid
  68          *
  69          * @param       $actionName     The default action we shall execute
  70          * @return      $isValid                Whether the given action is valid
  71          * @throws      EmptyVariableException  Thrown if given action is not set
  72          */
  73         public function isActionValid ($actionName) {
  74                 // By default nothing shall be valid
  75                 $isValid = FALSE;
  76
  77                 // Is a action set?
  78                 if (empty($actionName)) {
  79                         // Then thrown an exception here
  80                         throw new EmptyVariableException(array($this, 'actionName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  81                 } // END - if
  82
  83                 // Create class name
  84                 $className = $this->getCapitalizedClassPrefix() . self::convertToClassName($actionName) . 'Action';
  85
  86                 // Now, let us create the full name of the action class
  87                 $this->setClassName($className);
  88
  89                 // Is this class already loaded?
  90                 if (class_exists($this->getClassName())) {
  91                         // This class does exist. :-)
  92                         $isValid = TRUE;
  93                 } // END - if
  94
  95                 // Set action name
  96                 $this->setActionName($actionName);
  97
  98                 // Return the result
  99                 return $isValid;
 100         }
 101
 102         /**
 103          * "Loads" current action and instances it if not yet cached
 104          *
 105          * @return      $actionInstance                 A loaded action instance
 106          */
 107         protected function loadAction () {
 108                 // Init action instance
 109                 $actionInstance = NULL;
 110
 111                 // Create action class name
 112                 $className = $this->getCapitalizedClassPrefix() . self::convertToClassName($this->getActionName()) . 'Action';
 113
 114                 // ... and set it
 115                 $this->setClassName($className);
 116
 117                 // Initiate the action
 118                 $actionInstance = ObjectFactory::createObjectByName($this->getClassName(), array($this));
 119
 120                 // Return the result
 121                 return $actionInstance;
 122         }
 123
 124 }