environment/classes/controller/Controller.class.php

   1 <?php
   2
   3   /**
   4   * Base controller class
   5   *
   6   * This class is inherited by all script controllers. All methods of this class
   7   * are reserved - there can't be actions with that names (for instance, there
   8   * can't be execute actions in real controllers).
   9   *
  10   * @version 1.0
  11   * @http://www.projectpier.org/
  12   * @abstract
  13   */
  14   class Controller {
  15
  16     /**
  17     * This controller name
  18     *
  19     * @var string
  20     */
  21     private $controller_name;
  22
  23     /**
  24     * Action that was (or need to be) executed
  25     *
  26     * @var string
  27     */
  28     private $action;
  29
  30     /**
  31     * System controller class. System controller class is class withch methods
  32     * are reserved (can't be called). Basic system controllers are Controller and
  33     * PageController classes.
  34     *
  35     * @var string
  36     */
  37     private $system_controller_class;
  38
  39     /**
  40     * Contruct controller and set controller name
  41     *
  42     * @access public
  43     * @param void
  44     * @return null
  45     */
  46     function __construct() {
  47
  48       // Get controller name (tableized classname) and controller class
  49       $this->setControllerName( Env::getControllerName( get_class($this) ) );
  50       $this->setSystemControllerClass('Controller');
  51
  52     } // __construct
  53
  54     /**
  55     * Execute specific controller action
  56     *
  57     * @access public
  58     * @param string $action
  59     * @return InvalidControllerActionError if action name is not valid or true
  60     */
  61     function execute($action) {
  62
  63       // Prepare action name
  64       $action = trim(strtolower($action));
  65
  66       // If we have valid action execute and done... Else throw exception
  67       if($this->validAction($action)) {
  68         $this->setAction($action);
  69         $this->$action();
  70         return true;
  71       } else {
  72         throw new InvalidControllerActionError($this->getControllerName(), $action);
  73       } // if
  74
  75     } // execute
  76
  77     /**
  78     * Forward to specific contrller / action
  79     *
  80     * @access public
  81     * @param string $action
  82     * @param string $controller. If this value is NULL current controller will be
  83     *   used
  84     * @return null
  85     */
  86     function forward($action, $controller = null) {
  87       return empty($controller) ? $this->execute($action) : Env::executeAction($controller, $action);
  88     } // forward
  89
  90     /**
  91     * Check if specific $action is valid controller action (method exists and it is not reserved)
  92     *
  93     * @access public
  94     * @param string $action
  95     * @return boolean or Error
  96     */
  97     function validAction($action) {
  98
  99       // Get reserved names and check action name...
 100       $reserved_names = Controller::getReservedActionNames();
 101       if(is_array($reserved_names) && in_array($action, $reserved_names)) return false;
 102
 103       // Get methods of this class...
 104       $methods = get_class_methods(get_class($this));
 105
 106       // If we don't have defined action return false
 107       if(!in_array($action, $methods)) return false;
 108
 109       // All fine...
 110       return true;
 111
 112     } // validAction
 113
 114     // -------------------------------------------------------
 115     // Getters and setters
 116     // -------------------------------------------------------
 117
 118     /**
 119     * Get controller_name
 120     *
 121     * @access public
 122     * @param null
 123     * @return string
 124     */
 125     function getControllerName() {
 126       return $this->controller_name;
 127     } // getControllerName
 128
 129     /**
 130     * Set controller_name value
 131     *
 132     * @access public
 133     * @param string $value
 134     * @return null
 135     */
 136     function setControllerName($value) {
 137       $this->controller_name = $value;
 138     } // setControllerName
 139
 140     /**
 141     * Get action
 142     *
 143     * @access public
 144     * @param null
 145     * @return string
 146     */
 147     function getAction() {
 148       return $this->action;
 149     } // getAction
 150
 151     /**
 152     * Set action value
 153     *
 154     * @access public
 155     * @param string $value
 156     * @return null
 157     */
 158     function setAction($value) {
 159       $this->action = $value;
 160     } // setAction
 161
 162     /**
 163     * Get system_controller_class
 164     *
 165     * @access public
 166     * @param null
 167     * @return string
 168     */
 169     function getSystemControllerClass() {
 170       return $this->system_controller_class;
 171     } // getSystemControllerClass
 172
 173     /**
 174     * Set system_controller_class value
 175     *
 176     * @access public
 177     * @param string $value
 178     * @return null
 179     */
 180     function setSystemControllerClass($value) {
 181       $this->system_controller_class = $value;
 182     } // setSystemControllerClass
 183
 184     /**
 185     * Return reserved action names (methods of controller class)
 186     *
 187     * @access private
 188     * @param void
 189     * @return arrays
 190     */
 191     function getReservedActionNames() {
 192       static $names;
 193
 194       // Get and check controller class
 195       $controller_class = $this->getSystemControllerClass();
 196       if(!class_exists($controller_class)) throw new Error("Controller class '$controller_class' does not exists");
 197
 198       // If we don't have names get them
 199       if(is_null($names)) {
 200         $names = get_class_methods($controller_class);
 201         foreach($names as $k => $v) $names[$k] = strtolower($v);
 202       } // if
 203
 204       // And return...
 205       return $names;
 206
 207     } // getReservedActionNames
 208
 209   } // Controller
 210
 211 ?>