Changeset 163 for trunk/trax/vendor/trax/action_controller.php

Timestamp:

03/07/06 09:44:21 (6 years ago)

Author:

haas

Message:

partial doc, test of ActionController?

Files:

• trunk/trax/vendor/trax/action_controller.php (modified) (18 diffs)

trunk/trax/vendor/trax/action_controller.php

@@ -186 +186 @@
 
     /**
-     *  @todo Document this attribute
+     *  Name of the controller (without the _controller.php)
+     *
+     *  Set by {@link recognize_route()}
+     *  @var string
      */
     private $controller;
 
     /**
-     *  @todo Document this attribute
+     *  Name of the action method in the controller class
+     *
+     *  Set by {@link recognize_route()}
+     *  @var string
      */
     private $action;
@@ -201 +207 @@
 
     /**
-     *  @todo Document this attribute
+     *  Filesystem path to ../app/controllers/ directory
+     *
+     *  Set by {@link recognize_route()}
+     *  @var string
      */
     private $controllers_path;
 
     /**
-     *  @todo Document this attribute
+     *  Filesystem path to ../app/helpers/ directory
+     *
+     *  Set by {@link recognize_route()}
+     *  @var string
      */
     private $helpers_path;
@@ -216 +228 @@
 
     /**
-     *  @todo Document this attribute
+     *  Filesystem path to ../app/layouts/ directory
+     *
+     *  Set by {@link recognize_route()}
+     *  @todo <b>FIXME:</> declare $layouts_base_path
+     *  @var string
      */
     private $layouts_path;
 
     /**
-     *  @todo Document this attribute
+     *  User's URL in components
+     *
+     *  Contains user's URL stripped of TRAX_URL_PREFIX and leading
+     *  and trailing slashes, then exploded into an array on slash
+     *  boundaries.
+     *  @var string[]
      */
     private $url_path;
 
     /**
-     *  @todo Document this attribute
+     *  Filesystem path to the default layouts file application.phtml
+     *
+     *  Set by {@link recognize_route()}
+     *  @var string
      */
     private $default_layout_file;
@@ -236 +260 @@
 
     /**
-     *  @todo Document this attribute
+     *  Filesystem path to application.php file
+     *
+     *  Set by {@link recognize_route()}
+     *  @var string
      */
     private $application_controller_file;
 
     /**
-     *  @todo Document this attribute
+     *  Filesystem path to application_helper.php file
+     *
+     *  Set by {@link recognize_route()}
+     *  @var string
      */
     private $application_helper_file;
 
     /**
-     *  @todo Document this attribute
+     *  URL recognized, paths resoved, controller file found
+     *
+     *  Set by {@link recognize_route()}
+     *  @var boolean
      */
     private $loaded = false;
@@ -258 +291 @@
      *    <li>false => no Router object exists</li>
      *  </ul>
+     *  @todo <b>FIXME:</b> No declaration of $router so no place to hang
+     *    its documentation.
      */
     private $router_loaded = false;
@@ -297 +332 @@
 
     /**
-     *  @todo Document this attribute
+     *  Filesystem path to the ../app/views/ directory
+     *
+     *  Set by {@link recognize_route()}
+     *  @var string
      */
     public $views_path;
@@ -322 +360 @@
 
     /**
+     *  Build a Router object and load routes from config/route.php
+     *  @uses load_router()
+     */
+    function __construct() {
+        if(!isset($this->router) || !is_object($this->router)) {
+            $this->load_router();
+        }
+    }
+
+    /**
      *  @todo Document this method
-     */
-    function __construct() {
-      if(!isset($this->router) || !is_object($this->router)) {
-            $this->load_router();
-        }
-    }
-
-    /**
-     *  @todo Document this method
+     *  @uses add_after_filter()
+     *  @uses add_before_filter()
+     *  @uses add_helper()
      */
     function __set($key, $value) {
-        #echo "setting: $key = $value<br>";
         if($key == "before_filter") {
             $this->add_before_filter($value);
@@ -348 +389 @@
     /**
      *  @todo Document this method
+     *  Implement before_filter(), after_filter(), helper()
      */
     function __call($method_name, $parameters) {
@@ -366 +408 @@
 
     /**
-     *  Load routes from configuration file routes.php
+     *  Load routes from configuration file config/routes.php
      *
      *  Routes are loaded by requiring {@link routes.php} from the
-     *  configuration directory.
+     *  configuration directory.  The file routes.php contains
+     *  statements of the form "$router->connect(path,params);" where
+     *  (path,params) describes the route being added by the
+     *  statement. Route syntax is described in
+     *  {@tutorial PHPonTrax/Router.cls the Router class tutorial}.
+     *
      *  @uses Router
      *  @uses $router
@@ -377 +424 @@
         $this->router_loaded = false;
         $router = new Router();
-        # Load the routes
-        require_once(TRAX_ROOT.$GLOBALS['TRAX_INCLUDES']['config']."/routes.php");
+
+        // Load the routes.
+        require(TRAX_ROOT.$GLOBALS['TRAX_INCLUDES']['config']."/routes.php");
         $this->router = $router;
         if(is_object($this->router)) {
@@ -386 +434 @@
 
     /**
-     *  @todo Document this method
+     *  Convert URL to controller, action and id
+     *
+     *  Parse the URL in $_SERVER['REDIRECT_URL'] into elements.
+     *  Compute filesystem paths to the various components used by the
+     *  URL and store the paths in object private variables.
+     *  Verify that the controller exists.
+     *
      *  @uses load_router()
+     *  @uses $action
+     *  @uses $application_controller_file
+     *  @uses $controller
+     *  @uses $controller_class
+     *  @uses $controller_file
+     *  @uses $controllers_path
+     *  @uses $default_layout_file
+     *  @uses $helper_file
+     *  @uses $helpers_path
+     *  @uses $id
+     *  @uses $layouts_path
+     *  @uses $loaded
      *  @uses $router
      *  @uses $router_loaded
      *  @uses set_paths()
      *  @uses $url_path
+     *  @uses $views_file_extention
+     *  @uses $views_path
+     *  @return boolean
+     *  <ul>
+     *    <li>true =>  route recognized, controller found.</li>
+     *    <li>false => failed, route not recognized.</li>
+     *  </ul>
      */
     function recognize_route() {
-
         if(!$this->router_loaded) {
             $this->load_router();
@@ -448 +520 @@
                 }
 
+                //  FIXME: get a warning if ':id' not in $url_path
                 if(@in_array(":id",$route_path)) {
                     $this->id = strtolower($this->url_path[@array_search(":id", $route_path)]);
@@ -473 +546 @@
     /**
      *  @todo Document this method
+     *  @uses $action
+     *  @uses $application_controller_file
+     *  @uses $application_helper_file
+     *  @uses $controller
+     *  @uses $controller_class
+     *  @uses $controller_file
+     *  @uses $controller_object
+     *  @uses determine_layout()
+     *  @uses execute_after_filters()
+     *  @uses $helpers
+     *  @uses $helper_file
+     *  @uses $helpers_base_path
+     *  @uses $keep_flash
+     *  @uses $loaded
+     *  @uses recognize_route()
+     *  @uses raise()
+     *  @uses ScaffoldController
+     *  @uses $view_file
+     *  @uses $views_file_extention
+     *  @uses $views_path
+     *  @return boolean true
      */
     function process_route() {
 
-        # First try to load the routes and setup the pathes to everything
+        # First try to load the routes and setup the paths to everything
         if(!$this->loaded) {
             if(!$this->recognize_route()) {
@@ -494 +588 @@
 
         # Include the controller file and execute action
+        // FIXME: redundant, recognize_route() already test for file exists
         if(file_exists($this->controller_file)) {
             include_once($this->controller_file);
@@ -502 +597 @@
                     $this->controller_object->controller = $this->controller;
                     $this->controller_object->action = $this->action;
+                    //  FIXME: $added_path doesn't exist at this point
                     $this->controller_object->controller_path = "$this->added_path/$this->controller";
                     $GLOBALS['current_controller_path'] = "$this->added_path/$this->controller";
@@ -635 +731 @@
     /**
      *  @todo Document this method
+     *  @uses $added_path
+     *  @uses $controllers_path
+     *  @uses $helpers_path
+     *  @uses $layous_path
+     *  @uses $views_path
+     *  @uses $url_path
      */
     function set_paths() {
@@ -821 +923 @@
     /**
      *  @todo Document this method
+     *  @uses $controller_object
+     *  @uses $layouts_base_path
+     *  @uses $layouts_path
+     *  @return mixed Layout file or null if none
+     *  @todo <b>FIXME:</b> Should this method be private?
      */
     function determine_layout() {
         # I guess you don't want any layout
+        // FIXME: Do we really want to test for null here?
+        // It might make more sense to test isset(...layout)
         if($this->controller_object->layout == "null") {
             return null;
@@ -848 +957 @@
             }
         }
-        # No defined layout found so just use the default layout app/views/layouts/application.phtml
+        //  No defined layout found so just use the default layout
+        //  app/views/layouts/application.phtml 
+        //  FIXME: this file isn't in the distribution so
+        //  this reference will fail
         if(!$layout_file) {
             $layout_file = $this->default_layout_file;