Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

Class JRouter

Description
Description | Variables (details) | Methods (details)

Class to create and parse routes

Located in /joomla/application/router.php (line 97) 

Class JObject   (Subpackage Base)

Class JRouter   (Subpackage Application)
Variable Summary
Description | Variables (details) | Methods (details)
Variable integer $_mode
Method Summary
Description | Variables (details) | Methods (details)
Constructor JRouter __construct ([ $options = array()])
Method string build ( $value, string $string)
Method JRouter &getInstance ([ $options = array()])
Method void parse ( $url)
Method void _buildApplicationRoute ( &$query)
Method void _buildComponentRoute ( &$query)
Method void _decodeSegments ( $segments)
Method void _encodeSegments ( $segments)
Method void _parseApplicationRoute ( &$url)
Method void _parseComponentRoute ( $url)
Variables
Description | Variables (details) | Methods (details)
integer $_mode = null (line 105)

The rewrite mode

  • access: protected
Methods
Description | Variables (details) Methods (details)
Constructor __construct (line 112)

Class constructor

  • access: public
JRouter __construct ([ $options = array()])
  • $options
Redefinition of:
JObject::__construct()
Class constructor, overridden in descendant classes.
build (line 203)

Function to convert an internal URI to a route

  • return: The absolute search engine friendly URL
  • since: 1.5
string build ( $value, string $string)
  • string $string: The internal URL
  • $value
getInstance (line 132)

Returns a reference to the global Router object, only creating it if it doesn't already exist.

This method must be invoked as: 

  $router = &JRouter::getInstance();

  • return: The Router object.
  • since: 1.5
  • access: public
JRouter &getInstance ([ $options = array()])
  • $options
parse (line 148)

Route a request

  • access: public
void parse ( $url)
  • $url
_buildApplicationRoute (line 368)

Build the application specific route

  • access: protected
void _buildApplicationRoute ( &$query)
  • &$query
_buildComponentRoute (line 392)

Build the component specific route

  • access: protected
void _buildComponentRoute ( &$query)
  • &$query
_decodeSegments (line 439)
void _decodeSegments ( $segments)
  • $segments
_encodeSegments (line 429)
void _encodeSegments ( $segments)
  • $segments
_parseApplicationRoute (line 294)

Parse a application specific route

  • access: protected
void _parseApplicationRoute ( &$url)
  • &$url
_parseComponentRoute (line 335)

Parse a component specific route

  • access: protected
void _parseComponentRoute ( $url)
  • $url

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()
Documentation generated on Mon, 05 Mar 2007 21:20:24 +0000 by phpDocumentor 1.3.1