Class JRouterSite

Description

Class to create and parse routes for the site application

  • since: 1.5

Located in /libraries/cms/router/site.php (line 19)

JRouter
   |
   --JRouterSite
Method Summary
 string build (string $url)
 void buildSefRoute (JUri &$uri)
 JUri createURI (string $url)
 array parse (JUri &$uri)
 array parseRawRoute (JUri &$uri)
 string parseSefRoute (JUri &$uri)
 void processBuildRules (JUri &$uri)
 array processParseRules (JUri &$uri)
 void _buildSefRoute (JUri &$uri)
Variables
Methods
build (line 96)

Function to convert an internal URI to a route

  • return: The absolute search engine friendly URL
  • since: 1.5
  • access: public
string build (string $url)
  • string $url: The internal URL

Redefinition of:
JRouter::build()
Function to convert an internal URI to a route
buildSefRoute (line 407)

Function to build a sef route

  • since: 3.2
  • access: protected
void buildSefRoute (JUri &$uri)
  • JUri &$uri: The uri

Redefinition of:
JRouter::buildSefRoute()
Function to build a sef route
createURI (line 594)

Create a uri based on a full or partial url string

  • since: 3.2
  • access: protected
JUri createURI (string $url)
  • string $url: The URI

Redefinition of:
JRouter::createURI()
Create a uri based on a full or partial url string
parse (line 30)

Function to convert a route to an internal URI

  • since: 1.5
  • access: public
array parse (JUri &$uri)
  • JUri &$uri: The uri.

Redefinition of:
JRouter::parse()
Function to convert a route to an internal URI
parseRawRoute (line 146)

Function to convert a raw route to an internal URI

  • since: 3.2
  • access: protected
array parseRawRoute (JUri &$uri)
  • JUri &$uri: The raw route

Redefinition of:
JRouter::parseRawRoute()
Function to convert a raw route to an internal URI
parseSefRoute (line 207)

Function to convert a sef route to an internal URI

  • return: Internal URI
  • since: 3.2
  • access: protected
string parseSefRoute (JUri &$uri)
  • JUri &$uri: The sef URI

Redefinition of:
JRouter::parseSefRoute()
Function to convert a sef route to an internal URI
processBuildRules (line 547)

Process the build uri query data based on custom defined rules

  • since: 3.2
  • access: protected
void processBuildRules (JUri &$uri)
  • JUri &$uri: The URI

Redefinition of:
JRouter::processBuildRules()
Process the build uri query data based on custom defined rules
processParseRules (line 520)

Process the parsed router variables based on custom defined rules

  • return: The array of processed URI variables
  • since: 3.2
  • access: protected
array processParseRules (JUri &$uri)
  • JUri &$uri: The URI to parse

Redefinition of:
JRouter::processParseRules()
Process the parsed router variables based on custom defined rules
_buildSefRoute (line 393)

Function to build a sef route

  • deprecated: 4.0 Use buildSefRoute() instead
  • since: 1.5
  • access: protected
void _buildSefRoute (JUri &$uri)
  • JUri &$uri: The internal URL

Redefinition of:
JRouter::_buildSefRoute()
Function to build a sef route

Inherited Methods

Inherited From JRouter

 JRouter::__construct()
 JRouter::attachBuildRule()
 JRouter::attachParseRule()
 JRouter::build()
 JRouter::buildRawRoute()
 JRouter::buildSefRoute()
 JRouter::createURI()
 JRouter::decodeSegments()
 JRouter::encodeSegments()
 JRouter::getInstance()
 JRouter::getMode()
 JRouter::getVar()
 JRouter::getVars()
 JRouter::parse()
 JRouter::parseRawRoute()
 JRouter::parseSefRoute()
 JRouter::processBuildRules()
 JRouter::processParseRules()
 JRouter::setMode()
 JRouter::setVar()
 JRouter::setVars()
 JRouter::_buildRawRoute()
 JRouter::_buildSefRoute()
 JRouter::_createURI()
 JRouter::_decodeSegments()
 JRouter::_encodeSegments()
 JRouter::_parseRawRoute()
 JRouter::_parseSefRoute()
 JRouter::_processBuildRules()
 JRouter::_processParseRules()

Documentation generated on Tue, 19 Nov 2013 15:13:52 +0100 by phpDocumentor 1.4.3