Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250620) (7d9030acd6e)
Slim\Routing\RouteParser Class Reference
Inheritance diagram for Slim\Routing\RouteParser:
Slim\Interfaces\RouteParserInterface

Public Member Functions

 __construct (RouteCollectorInterface $routeCollector)
 
 fullUrlFor (UriInterface $uri, string $routeName, array $data=[], array $queryParams=[])
 {Get fully qualified URL for named route.
Parameters
UriInterface$uri
string$routeNameRoute name
array<string,string>$data Named argument replacement data
array<string,string>$queryParams Optional query string parameters
}
 
 relativeUrlFor (string $routeName, array $data=[], array $queryParams=[])
 {Build the path for a named route excluding the base path.
Parameters
string$routeNameRoute name
array<string,string>$data Named argument replacement data
array<string,string>$queryParams Optional query string parameters
Exceptions
RuntimeExceptionIf named route does not exist
InvalidArgumentExceptionIf required data not provided
}
 
 urlFor (string $routeName, array $data=[], array $queryParams=[])
 {Build the path for a named route including the base path.
Parameters
string$routeNameRoute name
array<string,string>$data Named argument replacement data
array<string,string>$queryParams Optional query string parameters
Exceptions
RuntimeExceptionIf named route does not exist
InvalidArgumentExceptionIf required data not provided
}
 

Member Function Documentation

◆ fullUrlFor()

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

{Get fully qualified URL for named route.

Parameters
UriInterface$uri
string$routeNameRoute name
array<string,string>$data Named argument replacement data
array<string,string>$queryParams Optional query string parameters
}

Implements Slim\Interfaces\RouteParserInterface.

◆ relativeUrlFor()

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

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

Parameters
string$routeNameRoute name
array<string,string>$data Named argument replacement data
array<string,string>$queryParams Optional query string parameters
Exceptions
RuntimeExceptionIf named route does not exist
InvalidArgumentExceptionIf required data not provided
}

Implements Slim\Interfaces\RouteParserInterface.

◆ urlFor()

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

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

Parameters
string$routeNameRoute name
array<string,string>$data Named argument replacement data
array<string,string>$queryParams Optional query string parameters
Exceptions
RuntimeExceptionIf named route does not exist
InvalidArgumentExceptionIf required data not provided
}

Implements Slim\Interfaces\RouteParserInterface.


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