Framework router class. More...

Public Member Functions
	__construct ($base_path)
	Constructs a router instance.
	getModule ($route)
	Sets the module and method properties.
	linkAjax ($module, $method, $params=array())
	Ajax link generation.
	linkHref ($module, $method, $params=array(), $opts=null)
	Link generation.
	loader ($route)
	Loads a module controller and returns its called method.
	method ()
	Returns the method called by url.
	module ()
	Returns the module called by url.
Private Attributes
	$_base_path
	base path for link generation
	$_method
	method called by url
	$_module
	module called by url
	$_registry
	the registry singleton instance

Detailed Description

Framework router class.

This class is used to load/call class methods, it includes the proper class file, instantiates the module's controller and call its method. Also it exports the url module and method to use for example in the template factory.

Author:: abidibo abidi.nosp@m.bo@g.nosp@m.mail..nosp@m.com

Version:: 0.99

Date:: 2011-2012

Copyright:: Otto srl MIT License

Definition at line 25 of file router.class.php.

Constructor & Destructor Documentation

router::__construct ( $ base_path )

Constructs a router instance.

Parameters:

string $base_path the base path

Returns:: void

Definition at line 53 of file router.class.php.

Here is the call graph for this function:

Member Function Documentation

router::getModule ( $ route )

Sets the module and method properties.

Parameters:

array

$route

the class and method to set. Possible values are:

associative array in the form array('module'=>'module_name', 'method'=>'method_name')
null: the class name and method name are taken directly from url

Returns:: void

Definition at line 131 of file router.class.php.

Here is the caller graph for this function:

router::linkAjax	(	$	module,
		$	method,
		$	params = `array()`
	)

Ajax link generation.

This method is used to generate links which points directly to a controller class method, without considering the whole document (themes, templates and so on). Generally used to perform ajax requests.

Parameters:

string	$module	module name (the name of the model class)
string	$method	method name
array	$params	associative array of parameters in the form array('param_name'=>'param_value')

Returns:: void

Definition at line 187 of file router.class.php.

router::linkHref	(	$	module,
		$	method,
		$	params = `array()`,
		$	opts = `null`
	)

Link generation.

This method is used to generate links starting from a module name, one of its methods and additional parameters

Parameters:

string	$module	module name (the name of the model class)
string	$method	method name
array	$params	associative array of parameters in the form array('param_name'=>'param_value')
mixed	$opts	associative array of oprions: permalink: whether to use permalinks or not (i.e. '/class/method/param/value' 'against /index.php?module=class&method=method&param=value'

Returns:: void

Definition at line 158 of file router.class.php.

Here is the call graph for this function:

router::loader ( $ route )

Loads a module controller and returns its called method.

Parameters:

array

$route

the class and method to call. Possible values are:

associative array in the form array('module'=>'module_name', 'method'=>'method_name')
null: the class name and method name are taken directly from url if the method is not found or not callable the 'index' method is called public