\JRouter

Class to create and parse routes

Synopsis

class JRouter {

• // members
• protected  $mode;
• protected  $_mode;
• protected  $vars;
• protected  $_vars;
• protected  $rules;
• protected  $_rules;
• protected  $instances;
• // methods
• public void __construct()
• public static JRouter getInstance()
• public array parse()
• public string build()
• public integer getMode()
• public void setMode()
• public void setVar()
• public void setVars()
• public mixed getVar()
• public array getVars()
• public void attachBuildRule()
• public void attachParseRule()
• protected boolean _parseRawRoute()
• protected boolean parseRawRoute()
• protected string _parseSefRoute()
• protected string parseSefRoute()
• protected string _buildRawRoute()
• protected string buildRawRoute()
• protected string _buildSefRoute()
• protected string buildSefRoute()
• protected array _processParseRules()
• protected array processParseRules()
• protected void _processBuildRules()
• protected void processBuildRules()
• protected JUri _createURI()
• protected JUri createURI()
• protected array _encodeSegments()
• protected array encodeSegments()
• protected array _decodeSegments()
• protected array decodeSegments()
}


Hierarchy

Extended by

• JRouterInstallation
• JRouterAdministrator
• JRouterSite

Members

protected

• $_mode — integer
  The rewrite mode
• $_rules — array
  An array of rules
• $_vars — array
  An array of variables
• $instances — array
  JRouter instances container.
• $mode — integer
  The rewrite mode
• $rules — array
  An array of rules
• $vars — array
  An array of variables

Methods

protected

• _buildRawRoute() — Function to build a raw route
• _buildSefRoute() — Function to build a sef route
• _createURI() — Create a uri based on a full or partial url string
• _decodeSegments() — Decode route segments
• _encodeSegments() — Encode route segments
• _parseRawRoute() — Function to convert a raw route to an internal URI
• _parseSefRoute() — Function to convert a sef route to an internal URI
• _processBuildRules() — Process the build uri query data based on custom defined rules
• _processParseRules() — Process the parsed router variables based on custom defined rules
• buildRawRoute() — Function to build a raw route
• buildSefRoute() — Function to build a sef route
• createURI() — Create a uri based on a full or partial url string
• decodeSegments() — Decode route segments
• encodeSegments() — Encode route segments
• parseRawRoute() — Function to convert a raw route to an internal URI
• parseSefRoute() — Function to convert a sef route to an internal URI
• processBuildRules() — Process the build uri query data based on custom defined rules
• processParseRules() — Process the parsed router variables based on custom defined rules

public

• __construct() — Class constructor
• attachBuildRule() — Attach a build rule
• attachParseRule() — Attach a parse rule
• build() — Function to convert an internal URI to a route
• getInstance() — Returns the global JRouter object, only creating it if it doesn't already exist.
• getMode() — Get the router mode
• getVar() — Get a router variable
• getVars() — Get the router variable array
• parse() — Function to convert a route to an internal URI
• setMode() — Set the router mode
• setVar() — Set a router variable, creating it if it doesn't exist
• setVars() — Set the router variable array