Public Member Functions
	__construct (\Elgg\PluginHooksService $hooks)
	Constructor. More...

	route (\Elgg\Http\Request $request)
	Routes the request to a registered page handler. More...

	registerPageHandler ($identifier, $function)
	Register a function that gets called when the first part of a URL is equal to the identifier. More...

	unregisterPageHandler ($identifier)
	Unregister a page handler for an identifier. More...

	getPageHandlers ()
	Get page handlers as array of identifier => callback. More...

Detailed Description

Definition at line 16 of file Router.php.

Constructor & Destructor Documentation

Elgg\Router::__construct ( \Elgg\PluginHooksService $hooks )

Constructor.

Parameters

\Elgg\PluginHooksService $hooks For customized routing.

Definition at line 25 of file Router.php.

Elgg\Router::getPageHandlers ( )

Get page handlers as array of identifier => callback.

Definition at line 120 of file Router.php.

Elgg\Router::registerPageHandler	(	$identifier,
		$function
	)

Register a function that gets called when the first part of a URL is equal to the identifier.

Parameters

string	$identifier	The page type to handle
string	$function	Your function name

Definition at line 95 of file Router.php.

Elgg\Router::route ( \Elgg\Http\Request $request )

Routes the request to a registered page handler.

This function triggers a plugin hook ‘'route’, $identifier` so that plugins can modify the routing or handle a request.

Parameters

\Elgg\Http\Request $request The request to handle.

Returns: boolean Whether the request was routed successfully. @access private

Definition at line 39 of file Router.php.

Elgg\Router::unregisterPageHandler ( $identifier )

Unregister a page handler for an identifier.

Parameters

string $identifier The page type identifier

Definition at line 111 of file Router.php.

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