Router Class Reference

Inheritance diagram for Router:

Public Member Functions
	__construct ($db, $basePath, $routes=array(), $matchTypes=array())
	get_asset_path ( $path)
	get_url ($url)
	is_active ( $route_name)
	has_route ($name)
	update_route ()

Public Attributes
	$route = NULL

Private Attributes
	$db

Detailed Description

An extension class to the altorouter library.

Constructor & Destructor Documentation

__construct()

Router::__construct	(		$db,
			$basePath,
			$routes = array(),
			$matchTypes = array()
	)

The constructor which calls the parent constructor.

Parameters

instance	$db	The instance of the service class PageDb
string	$basePath	The path prefix.
array	$routes	The array of existing routes.
array	$matchTypes	The set of types to match.

Member Function Documentation

get_asset_path()

Router::get_asset_path

(

$path

)

Get the path of an asset such that it matches with the base path.

Parameters

string

$path

The path to the asset.

Return values

string

The modified asset path.

get_url()

Router::get_url

(

$url

)

Returns an url given a router keyword. The keyword #back will generate the url of the last visited page or the home page if the last visited page is the current page or unknown. The keyword #self points to the current page.

Return values

string

The generated url.

Here is the call graph for this function:

has_route()

Router::has_route

(

$name

)

Checks whether the given route exists.

Parameters

string

$name

The name of the route

Return values

bool	True if the route exists, false otherwise.

Referenced by get_url().

is_active()

Router::is_active

(

$route_name

)

Check whther the given route is active.

Parameters

string

$route_name

The name of the route to check.

Return values

bool	True if the given path is active, false otherwise.

update_route()

Router::update_route

(

)

Updates the route array.

Member Data Documentation

$db

Router::$db

private

The instance of the service class PageDb.

Referenced by __construct().

$route

Router::$route = NULL

The router array which holds the name, target, and parameters of a route.

---

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

• server/service/Router.php