Route registration service. More...

Public Member Functions
	__construct (PluginHooksService $hooks, LoggerInterface $logger, RouteCollection $routes, UrlGenerator $generator)
	Constructor. More...

	register ($name, array $params=[])
	Register a new route. More...

	unregister ($name)
	Unregister a route by its name. More...

	get ($name)
	Get route config from its name. More...

	all ()
	Get all registered routes. More...

	generateUrl ($name, array $parameters=[])
	Generate a relative URL for a named route. More...

	resolveRouteParameters ($name, ElggEntity $entity=null, array $parameters=[])
	Populates route parameters from entity properties. 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...

Protected Attributes
	$hooks

	$routes

	$generator

Detailed Description

Route registration service.

Definition at line 19 of file RouteRegistrationService.php.

Constructor & Destructor Documentation

Elgg\Router\RouteRegistrationService::__construct	(	PluginHooksService	$hooks,
		LoggerInterface	$logger,
		RouteCollection	$routes,
		UrlGenerator	$generator
	)

Constructor.

Parameters

PluginHooksService	$hooks	Hook service
LoggerInterface	$logger	Logger
RouteCollection	$routes	Route collection
UrlGenerator	$generator	URL Generator

Definition at line 46 of file RouteRegistrationService.php.

Member Function Documentation

Elgg\Router\RouteRegistrationService::all ( )

Get all registered routes.

Returns: Route[]

Definition at line 183 of file RouteRegistrationService.php.

Elgg\Router\RouteRegistrationService::generateUrl	(		$name,
		array	$parameters = `[]`
	)

Generate a relative URL for a named route.

Parameters

string	$name	Route name
array	$parameters	Query parameters

Returns: false|string

Definition at line 195 of file RouteRegistrationService.php.

Elgg\Router\RouteRegistrationService::get ( $name )

Get route config from its name.

Parameters

string $name Route name

Returns: Route|null

Definition at line 175 of file RouteRegistrationService.php.

Elgg\Router\RouteRegistrationService::register	(		$name,
		array	$params = `[]`
	)

Register a new route.

Route paths can contain wildcard segments, i.e. /blog/owner/{username} To make a certain wildcard segment optional, add ? to its name, i.e. /blog/owner/{username?}

Wildcard requirements for common named variables such as 'guid' and 'username' will be set automatically.

Parameters

string	$name	Unique route name This name can later be used to generate route URLs
array	$params	Route parameters path : path of the route resource : name of the resource view defaults : default values of wildcard segments requirements : regex patterns for wildcard segment requirements methods : HTTP methods