PHPXRef 0.7.1 : Joomla 1.5.26 DE : Detail view of router.php

(no description)

Copyright:	Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License:	GNU/GPL, see LICENSE.php
Version:	$Id:router.php 8876 2007-09-13 22:54:03Z jinx $
File Size:	416 lines (8 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

JRouter:: (21 methods):
  __construct()
  getInstance()
  parse()
  build()
  getMode()
  setMode()
  setVar()
  setVars()
  getVar()
  getVars()
  attachBuildRule()
  attachParseRule()
  _parseRawRoute()
  _parseSefRoute()
  _buildRawRoute()
  _buildSefRoute()
  _processParseRules()
  _processBuildRules()
  _createURI()
  _encodeSegments()
  _decodeSegments()

Class: JRouter - X-Ref

Class to create and parse routes

__construct($options = array() X-Ref

Class constructor

getInstance($client, $options = array() X-Ref

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

This method must be invoked as:
<pre>  $menu = &JRouter::getInstance();</pre>

param: string  $client  The name of the client
param: array   $options An associative array of options
return: JRouter    A router object.

parse(&$uri) X-Ref

Function to convert a route to an internal URI

build($url) X-Ref

Function to convert an internal URI to a route

param: string $string The internal URL
return: string The absolute search engine friendly URL

getMode() X-Ref

Get the router mode

setMode($mode) X-Ref

Get the router mode

setVar($key, $value, $create = true) X-Ref

Set a router variable, creating it if it doesn't exist

param: string $key The name of the variable
param: mixed $value The value of the variable
param: boolean $create If True, the variable will be created if it doesn't exist yet

setVars($vars = array() X-Ref

Set the router variable array

param: array $vars An associative array with variables
param: boolean $create If True, the array will be merged instead of overwritten

getVar($key) X-Ref

Get a router variable

param: string $key The name of the variable

getVars() X-Ref

Get the router variable array

return: array An associative array of router variables

attachBuildRule($callback) X-Ref

Attach a build rule

param: callback $callback The function to be called.

attachParseRule($callback) X-Ref

Attach a parse rule

param: callback $callback The function to be called.

_parseRawRoute(&$uri) X-Ref

Function to convert a raw route to an internal URI

_parseSefRoute(&$uri) X-Ref

Function to convert a sef route to an internal URI

_buildRawRoute(&$uri) X-Ref

Function to build a raw route

_buildSefRoute(&$uri) X-Ref

Function to build a sef route

_processParseRules(&$uri) X-Ref

Process the parsed router variables based on custom defined rules

_processBuildRules(&$uri) X-Ref

Process the build uri query data based on custom defined rules

_createURI($url) X-Ref

Create a uri based on a full or partial url string

return: JURI A JURI object

_encodeSegments($segments) X-Ref

Encode route segments

param: array An array of route segments
return: array

_decodeSegments($segments) X-Ref

Decode route segments

param: array An array of route segments
return: array

PHP Cross Reference of Joomla 1.5.26 DE

/libraries/joomla/application/ -> router.php (summary)

Defines 1 class