inc/classes/main/resolver/class_BaseResolver.php

   1 <?php
   2 /**
   3  * A generic resolver class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 class BaseResolver extends BaseFrameworkSystem {
  25         /**
  26          * Class name
  27          */
  28         private $className = '';
  29
  30         /**
  31          * Prefix for class
  32          */
  33         private $classPrefix = '';
  34
  35         /**
  36          * (Last) resolved instance
  37          */
  38         private $resolvedInstance = NULL;
  39
  40         // Exception constants
  41         const EXCEPTION_INVALID_COMMAND    = 0x1d0;
  42         const EXCEPTION_INVALID_CONTROLLER = 0x1d1;
  43         const EXCEPTION_INVALID_ACTION     = 0x1d2;
  44         const EXCEPTION_INVALID_STATE      = 0x1d3;
  45
  46         /**
  47          * Protected constructor
  48          *
  49          * @param       $className      Real name of the class
  50          * @return      void
  51          */
  52         protected function __construct ($className) {
  53                 // Call parent constructor
  54                 parent::__construct($className);
  55         }
  56
  57         /**
  58          * Getter for class name
  59          *
  60          * @return      $className      Name of the class
  61          */
  62         public final function getClassName () {
  63                 return $this->className;
  64         }
  65
  66         /**
  67          * "Getter" for class name (useable for an object factory)
  68          *
  69          * @return      $className      Capitalized class name
  70          */
  71         protected function getCapitalizedClassPrefix () {
  72                 // Get class name
  73                 $className = $this->getClassPrefix();
  74
  75                 // And capitalize it
  76                 $className = $this->convertToClassName($className);
  77
  78                 // Return it
  79                 return $className;
  80         }
  81
  82         /**
  83          * Setter for class name
  84          *
  85          * @param       $className      Name of the class
  86          * @return      void
  87          */
  88         protected final function setClassName ($className) {
  89                 $this->className = (string) $className;
  90         }
  91
  92         /**
  93          * Getter for class prefix
  94          *
  95          * @return      $classPrefix    Last validated classPrefix
  96          */
  97         protected final function getClassPrefix () {
  98                 return $this->classPrefix;
  99         }
 100
 101         /**
 102          * Setter for class prefix
 103          *
 104          * @param       $classPrefix    Last validated classPrefix
 105          * @return      void
 106          */
 107         protected final function setClassPrefix ($classPrefix) {
 108                 $this->classPrefix = (string) $classPrefix;
 109         }
 110
 111         /**
 112          * Getter for (last) resolved instance
 113          *
 114          * @return      $resolvedInstance       Last validated resolvedInstance
 115          */
 116         protected final function getResolvedInstance () {
 117                 return $this->resolvedInstance;
 118         }
 119
 120         /**
 121          * Setter for (last) resolved instance
 122          *
 123          * @param       $resolvedInstance       (Last) validated resolved instance
 124          * @return      void
 125          */
 126         protected final function setResolvedInstance (FrameworkInterface $resolvedInstance) {
 127                 $this->resolvedInstance = $resolvedInstance;
 128         }
 129 }
 130
 131 // [EOF]
 132 ?>