RouterBase Class Reference
[Controller]

The Router. More...

Inheritance diagram for RouterBase:

List of all members.

Public Member Functions
	__construct ($class_instantiater)
	Constructor.
	get_route_id ()
	Returns the action invoked.
	initialize ($page_data)
	Initialize page data.
	on_event ($name, $params, &$result)
	Invoke event on all controllers.
	postprocess ($page_data)
	Do what's necessary after page was processed, e.g.
	preprocess ($page_data)
	Prepares all controllers.
	route ()
	Looks for a handler of given url and invokes it.
Protected Member Functions
	find_route ($path)
	Try to find matching controller.
	get_path ()
	Returns the current path, preprocessed.
Protected Attributes
	$controllers = array()
	Array of controllers.
	$current_route = null

---

Detailed Description

The Router.

Author:

Gerd Riesselmann

Definition at line 10 of file routerbase.cls.php.

---

Constructor & Destructor Documentation

RouterBase::__construct

(

$

class_instantiater

)

Constructor.

Loads all controllers

Definition at line 28 of file routerbase.cls.php.

                                                         {
                $potential_controllers = $class_instantiater->get_all();
                foreach ($potential_controllers as $controller) {
                        if ($controller instanceof IController) {
                                $this->controllers[] = $controller;
                        }
                }
                EventSource::Instance()->register($this);
        }

---

Member Function Documentation

RouterBase::find_route

(

$

path

)

[protected]

Try to find matching controller.

Definition at line 112 of file routerbase.cls.php.

                                             {
                if ($path === '') {
                        return null;
                }
                $best_matching_route = null;
                $best_weight = IRoute::WEIGHT_NO_MATCH;

                foreach ($this->controllers as $controller) {
                        $routes = $controller->get_routes();
                        foreach ($routes as $route) {
                                $weight = $route->weight_against_path($path);
                                //print $route->identify() . ': ' . $weight . '..' . $best_weight . '<br />';
                                if ($weight < $best_weight) {
                                        $best_matching_route = $route;
                                        $best_weight = $weight;
                                }
                        }
                }

                return $best_matching_route;
        }

RouterBase::get_path

(

)

[protected]

Returns the current path, preprocessed.

If index page is invoked, '.' is returned

Returns:

string The current path, e.g. path/to/page

Reimplemented in ConsoleRouter.

Definition at line 141 of file routerbase.cls.php.

                                      {
                // Check if index.php was invoked directly
                //if (RequestInfo::current()
                //      ->url_invoked(RequestInfo::RELATIVE) == Config::get_url(Config::URL_BASEDIR) . 'index.php'
                //) {
                //      return '';
                //}

                //$path = Arr::get_item($_GET, Config::get_value(Config::QUERY_PARAM_PATH_INVOKED), '.');

                // Switching to Url::current solves both the problem of detecting "index.php" from above
                // and some strange behaviour on (F)CGI machines, where
                // http://www.example.com/blah%3Fa%3Db gets passed as http://www.example.com/blah?a=b
                // whereas at the same time, the SERVER array contains the (correct!) original %3Fa%3Db,
                // which leads to confusion and may cause duplicate content URLs.
                $path = Url::current()->get_path();
                if ($path === '') {
                        $path = '.';
                }
                return $path;
        }

RouterBase::get_route_id

(

)

Returns the action invoked.

Definition at line 81 of file routerbase.cls.php.

                                       {
                $ret = '';
                if ($this->current_route) {
                        $ret = $this->current_route->identify();
                }
                return $ret;
        }

RouterBase::initialize

(

$

page_data

)

Initialize page data.

Definition at line 41 of file routerbase.cls.php.

                                               {
                $path = $this->get_path();
                //if (String::ends_with($path, '/')) {
                //      $path = trim($path, '/');
                //}
                $this->path_invoked = $path;
                $page_data->set_path($this->path_invoked);
                $page_data->router = $this;
        }

RouterBase::on_event	(	$	name,
		$	params,
		&$	result
	)

Invoke event on all controllers.

Implements IEventSink.

Definition at line 166 of file routerbase.cls.php.

                                                           {
                $ret = new Status();
                foreach ($this->controllers as $controller) {
                        $ret->merge($controller->on_event($name, $params, $result));
                }
                return $ret;
        }

RouterBase::postprocess

(

$

page_data

)

Do what's necessary after page was processed, e.g.

create sidebar items...

Definition at line 103 of file routerbase.cls.php.

                                                {
                foreach ($this->controllers as $controller) {
                        $controller->postprocess($page_data);
                }
        }

RouterBase::preprocess

(

$

page_data

)

Prepares all controllers.

Parameters:

string

Data of current page

Definition at line 94 of file routerbase.cls.php.

                                               {
                foreach ($this->controllers as $controller) {
                        $controller->preprocess($page_data);
                }
        }

RouterBase::route

(

)

Looks for a handler of given url and invokes it.

Returns:

IRoute

Definition at line 56 of file routerbase.cls.php.

                                {
                $token = $this->find_route($this->path_invoked);
                if (empty($token)) {
                        $token = new NotFoundRoute($this->path_invoked);
                }
                else {
                        // SImualte Apache behaviout that a becomes a/ if a/ is defiend, but a not
                        $path_current = Url::current()->get_path();
                        $current_is_dir = (substr($path_current, -1) === '/');
                        $route_is_dir = $token->is_directory();

                        if ($route_is_dir && !$current_is_dir) {
                                Url::current()->set_path($path_current . '/')->redirect(Url::PERMANENT);
                        }
                        else if (!$route_is_dir && $current_is_dir) {
                                Url::current()->set_path(rtrim($path_current, '/'))->redirect(Url::PERMANENT);
                        }
                }
                $this->current_route = $token;
                return $token;
        }

---

Member Data Documentation

RouterBase::$controllers = array() [protected]

Array of controllers.

Definition at line 16 of file routerbase.cls.php.

RouterBase::$current_route = null [protected]

Definition at line 23 of file routerbase.cls.php.

---

The documentation for this class was generated from the following file:

• gyro/core/controller/base/routerbase.cls.php