CI_Router Class Reference

List of all members.

Public Member Functions
	CI_Router ()
	Constructor.
	_set_routing ()
	Set the route mapping.
	_set_request ($segments=array())
	Set the Route.
	_validate_request ($segments)
	Validates the supplied segments.
	_parse_routes ()
	Parse Routes.
	set_class ($class)
	Set the class name.
	fetch_class ()
	Fetch the current class.
	set_method ($method)
	Set the method name.
	fetch_method ()
	Fetch the current method.
	set_directory ($dir)
	Set the directory name.
	fetch_directory ()
	Fetch the sub-directory (if any) that contains the requested controller class.
Public Attributes
	$config
	$routes = array()
	$error_routes = array()
	$class = ''
	$method = 'index'
	$directory = ''
	$uri_protocol = 'auto'
	$default_controller
	$scaffolding_request = FALSE

---

Detailed Description

Definition at line 29 of file Router.php.

---

Member Function Documentation

CI_Router::_parse_routes

(

)

Parse Routes.

This function matches any routes that may exist in the config/routes.php file against the URI to determine if the class/method need to be remapped.

private

Returns:

void

Definition at line 250 of file Router.php.

References _set_request().

Referenced by _set_routing().

        {
                // Do we even have any custom routing to deal with?
                // There is a default scaffolding trigger, so we'll look just for 1
                if (count($this->routes) == 1)
                {
                        $this->_set_request($this->uri->segments);
                        return;
                }

                // Turn the segment array into a URI string
                $uri = implode('/', $this->uri->segments);

                // Is there a literal match?  If so we're done
                if (isset($this->routes[$uri]))
                {
                        $this->_set_request(explode('/', $this->routes[$uri]));         
                        return;
                }
                                
                // Loop through the route array looking for wild-cards
                foreach ($this->routes as $key => $val)
                {                                               
                        // Convert wild-cards to RegEx
                        $key = str_replace(':any', '.+', str_replace(':num', '[0-9]+', $key));
                        
                        // Does the RegEx match?
                        if (preg_match('#^'.$key.'$#', $uri))
                        {                       
                                // Do we have a back-reference?
                                if (strpos($val, '$') !== FALSE AND strpos($key, '(') !== FALSE)
                                {
                                        $val = preg_replace('#^'.$key.'$#', $val, $uri);
                                }
                        
                                $this->_set_request(explode('/', $val));                
                                return;
                        }
                }

                // If we got this far it means we didn't encounter a
                // matching route so we'll set the site default route
                $this->_set_request($this->uri->segments);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Router::_set_request

(

$

segments = array()

)

Set the Route.

This function takes an array of URI segments as input, and sets the current class/method

private

Parameters:

	array
	bool

Returns:

void

Definition at line 146 of file Router.php.

References _validate_request(), set_class(), and set_method().

Referenced by _parse_routes().

        {       
                $segments = $this->_validate_request($segments);
                
                if (count($segments) == 0)
                {
                        return;
                }
                                                
                $this->set_class($segments[0]);
                
                if (isset($segments[1]))
                {
                        // A scaffolding request. No funny business with the URL
                        if ($this->routes['scaffolding_trigger'] == $segments[1] AND $segments[1] != '_ci_scaffolding')
                        {
                                $this->scaffolding_request = TRUE;
                                unset($this->routes['scaffolding_trigger']);
                        }
                        else
                        {
                                // A standard method request
                                $this->set_method($segments[1]);
                        }
                }
                else
                {
                        // This lets the "routed" segment array identify that the default
                        // index method is being used.
                        $segments[1] = 'index';
                }
                
                // Update our "routed" segment array to contain the segments.
                // Note: If there is no custom routing, this array will be
                // identical to $this->uri->segments
                $this->uri->rsegments = $segments;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Router::_set_routing

(

)

Set the route mapping.

This function determines what should be served based on the URI request, as well as any "routes" that have been set in the routing config file.

private

Returns:

void

Definition at line 65 of file Router.php.

References $route, _parse_routes(), _validate_request(), log_message(), set_class(), set_method(), and show_error().

Referenced by CI_Router().

        {
                // Are query strings enabled in the config file?
                // If so, we're done since segment based URIs are not used with query strings.
                if ($this->config->item('enable_query_strings') === TRUE AND isset($_GET[$this->config->item('controller_trigger')]))
                {
                        $this->set_class(trim($this->uri->_filter_uri($_GET[$this->config->item('controller_trigger')])));

                        if (isset($_GET[$this->config->item('function_trigger')]))
                        {
                                $this->set_method(trim($this->uri->_filter_uri($_GET[$this->config->item('function_trigger')])));
                        }
                        
                        return;
                }
                
                // Load the routes.php file.
                @include(APPPATH.'config/routes'.EXT);
                $this->routes = ( ! isset($route) OR ! is_array($route)) ? array() : $route;
                unset($route);

                // Set the default controller so we can display it in the event
                // the URI doesn't correlated to a valid controller.
                $this->default_controller = ( ! isset($this->routes['default_controller']) OR $this->routes['default_controller'] == '') ? FALSE : strtolower($this->routes['default_controller']);     
                
                // Fetch the complete URI string
                $this->uri->_fetch_uri_string();
        
                // Is there a URI string? If not, the default controller specified in the "routes" file will be shown.
                if ($this->uri->uri_string == '')
                {
                        if ($this->default_controller === FALSE)
                        {
                                show_error("Unable to determine what should be displayed. A default route has not been specified in the routing file.");
                        }

                        // Turn the default route into an array.  We explode it in the event that
                        // the controller is located in a subfolder
                        $segments = $this->_validate_request(explode('/', $this->default_controller));

                        // Set the class and method
                        $this->set_class($segments[0]);
                        $this->set_method('index');
                        
                        // Assign the segments to the URI class
                        $this->uri->rsegments = $segments;
                        
                        // re-index the routed segments array so it starts with 1 rather than 0
                        $this->uri->_reindex_segments();
                        
                        log_message('debug', "No URI present. Default controller set.");
                        return;
                }
                unset($this->routes['default_controller']);
                
                // Do we need to remove the URL suffix?
                $this->uri->_remove_url_suffix();
                
                // Compile the segments into an array
                $this->uri->_explode_segments();
                
                // Parse any custom routing that may exist
                $this->_parse_routes();         
                
                // Re-index the segment array so that it starts with 1 rather than 0
                $this->uri->_reindex_segments();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Router::_validate_request

(

$

segments

)

Validates the supplied segments.

Attempts to determine the path to the controller.

private

Parameters:

array

Returns:

array

Definition at line 194 of file Router.php.

References fetch_directory(), set_class(), set_directory(), set_method(), and show_404().

Referenced by _set_request(), and _set_routing().

        {
                // Does the requested controller exist in the root folder?
                if (file_exists(APPPATH.'controllers/'.$segments[0].EXT))
                {
                        return $segments;
                }

                // Is the controller in a sub-folder?
                if (is_dir(APPPATH.'controllers/'.$segments[0]))
                {               
                        // Set the directory and remove it from the segment array
                        $this->set_directory($segments[0]);
                        $segments = array_slice($segments, 1);
                        
                        if (count($segments) > 0)
                        {
                                // Does the requested controller exist in the sub-folder?
                                if ( ! file_exists(APPPATH.'controllers/'.$this->fetch_directory().$segments[0].EXT))
                                {
                                        show_404($this->fetch_directory().$segments[0]);
                                }
                        }
                        else
                        {
                                $this->set_class($this->default_controller);
                                $this->set_method('index');
                        
                                // Does the default controller exist in the sub-folder?
                                if ( ! file_exists(APPPATH.'controllers/'.$this->fetch_directory().$this->default_controller.EXT))
                                {
                                        $this->directory = '';
                                        return array();
                                }
                        
                        }

                        return $segments;
                }

                // Can't find the requested controller...
                show_404($segments[0]);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Router::CI_Router

(

)

Constructor.

Runs the route mapping function.

Definition at line 46 of file Router.php.

References _set_routing(), load_class(), and log_message().

        {
                $this->config =& load_class('Config');
                $this->uri =& load_class('URI');
                $this->_set_routing();
                log_message('debug', "Router Class Initialized");
        }

Here is the call graph for this function:

CI_Router::fetch_class

(

)

Fetch the current class.

public

Returns:

string

Definition at line 317 of file Router.php.

Referenced by fetch_method().

        {
                return $this->class;
        }

Here is the caller graph for this function:

CI_Router::fetch_directory

(

)

Fetch the sub-directory (if any) that contains the requested controller class.

public

Returns:

string

Definition at line 376 of file Router.php.

Referenced by _validate_request().

        {
                return $this->directory;
        }

Here is the caller graph for this function:

CI_Router::fetch_method

(

)

Fetch the current method.

public

Returns:

string

Definition at line 344 of file Router.php.

References fetch_class().

        {
                if ($this->method == $this->fetch_class())
                {
                        return 'index';
                }

                return $this->method;
        }

Here is the call graph for this function:

CI_Router::set_class

(

$

class

)

Set the class name.

public

Parameters:

string

Returns:

void

Definition at line 304 of file Router.php.

References $class.

Referenced by _set_request(), _set_routing(), and _validate_request().

        {
                $this->class = $class;
        }

Here is the caller graph for this function:

CI_Router::set_directory

(

$

dir

)

Set the directory name.

public

Parameters:

string

Returns:

void

Definition at line 363 of file Router.php.

Referenced by _validate_request().

        {
                $this->directory = $dir.'/';
        }

Here is the caller graph for this function:

CI_Router::set_method

(

$

method

)

Set the method name.

public

Parameters:

string

Returns:

void

Definition at line 331 of file Router.php.

References $method.

Referenced by _set_request(), _set_routing(), and _validate_request().

        {
                $this->method = $method;
        }

Here is the caller graph for this function:

---

Member Data Documentation

CI_Router::$class = ''

Definition at line 34 of file Router.php.

Referenced by set_class().

CI_Router::$config

Definition at line 31 of file Router.php.

CI_Router::$default_controller

Definition at line 38 of file Router.php.

CI_Router::$directory = ''

Definition at line 36 of file Router.php.

CI_Router::$error_routes = array()

Definition at line 33 of file Router.php.

CI_Router::$method = 'index'

Definition at line 35 of file Router.php.

Referenced by set_method().

CI_Router::$routes = array()

Definition at line 32 of file Router.php.

CI_Router::$scaffolding_request = FALSE

Definition at line 39 of file Router.php.

CI_Router::$uri_protocol = 'auto'

Definition at line 37 of file Router.php.

---

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

• Router.php