Slim\Interfaces\RouteParserInterface Interface Reference

Inheritance diagram for Slim\Interfaces\RouteParserInterface:

Public Member Functions
	fullUrlFor (UriInterface $uri, string $routeName, array $data=[], array $queryParams=[])
	Get fully qualified URL for named route.
	relativeUrlFor (string $routeName, array $data=[], array $queryParams=[])
	Build the path for a named route excluding the base path.
	urlFor (string $routeName, array $data=[], array $queryParams=[])
	Build the path for a named route including the base path.

Member Function Documentation

fullUrlFor()

Slim\Interfaces\RouteParserInterface::fullUrlFor	(	UriInterface	$uri,
		string	$routeName,
		array	$data = [],
		array	$queryParams = [] )

Get fully qualified URL for named route.

Parameters

UriInterface	$uri
string	$routeName	Route name
	array<string,string>	$data Named argument replacement data
	array<string,string>	$queryParams Optional query string parameters

Implemented in Slim\Routing\RouteParser.

relativeUrlFor()

Slim\Interfaces\RouteParserInterface::relativeUrlFor	(	string	$routeName,
		array	$data = [],
		array	$queryParams = [] )

Build the path for a named route excluding the base path.

Parameters

string	$routeName	Route name
	array<string,string>	$data Named argument replacement data
	array<string,string>	$queryParams Optional query string parameters

Exceptions

RuntimeException	If named route does not exist
InvalidArgumentException	If required data not provided

Implemented in Slim\Routing\RouteParser.

urlFor()

Slim\Interfaces\RouteParserInterface::urlFor	(	string	$routeName,
		array	$data = [],
		array	$queryParams = [] )

Build the path for a named route including the base path.

Parameters

string	$routeName	Route name
	array<string,string>	$data Named argument replacement data
	array<string,string>	$queryParams Optional query string parameters

Exceptions

RuntimeException	If named route does not exist
InvalidArgumentException	If required data not provided

Implemented in Slim\Routing\RouteParser.

---

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

• lib/slim/slim/Slim/Interfaces/RouteParserInterface.php