Route registration service. More...

Public Member Functions
	__construct (protected EventsService $events, protected RouteCollection $routes, protected UrlGenerator $generator)
	Constructor. More...

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

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

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

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

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

	resolveRouteParameters (string $name,?\ElggEntity $entity=null, array $parameters=[])
	Populates route parameters from entity properties. More...

Detailed Description

Route registration service.

Definition at line 16 of file RouteRegistrationService.php.

Constructor & Destructor Documentation

Elgg\Router\RouteRegistrationService::__construct	(	protected EventsService	$events,
		protected RouteCollection	$routes,
		protected UrlGenerator	$generator
	)

Constructor.

Parameters

EventsService	$events	Events service
RouteCollection	$routes	Route collection
UrlGenerator	$generator	URL Generator

Definition at line 27 of file RouteRegistrationService.php.

Member Function Documentation

Elgg\Router\RouteRegistrationService::all ( )

Get all registered routes.

Returns: Route[]

Definition at line 170 of file RouteRegistrationService.php.

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

Generate a absolute URL for a named route.

Parameters

string	$name	Route name
array	$parameters	Query parameters

Returns: string|null

Definition at line 182 of file RouteRegistrationService.php.

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

Get route config from its name.

Parameters

string $name Route name

Returns: Route|null

Definition at line 162 of file RouteRegistrationService.php.

Elgg\Router\RouteRegistrationService::register	(	string	$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 options : additional route options