HttpRouteParser
in package
implements
RouteParser
Class HttpRouteParser
Tags
Interfaces, Classes and Traits
- RouteParser
- Interface RouteParser
Table of Contents
- $internal : RouteParserInterface
- __construct() : mixed
- HttpRouteParser constructor.
- fullUrlFor() : string
- Get fully qualified URL for named route
- relativeUrlFor() : string
- Build the path for a named route excluding the base path
- urlFor() : string
- Build the path for a named route including the base path
Properties
$internal
private
RouteParserInterface
$internal
Methods
__construct()
HttpRouteParser constructor.
public
__construct(RouteParserInterface $internal) : mixed
Parameters
- $internal : RouteParserInterface
Return values
mixed —fullUrlFor()
Get fully qualified URL for named route
public
fullUrlFor(UriInterface $uri, string $routeName[, array<string|int, mixed> $data = [] ][, array<string|int, mixed> $queryParams = [] ]) : string
Parameters
- $uri : UriInterface
- $routeName : string
-
Route name
- $data : array<string|int, mixed> = []
-
Named argument replacement data
- $queryParams : array<string|int, mixed> = []
-
Optional query string parameters
Tags
Return values
string —relativeUrlFor()
Build the path for a named route excluding the base path
public
relativeUrlFor(string $routeName[, array<string|int, mixed> $data = [] ][, array<string|int, mixed> $queryParams = [] ]) : string
Parameters
- $routeName : string
-
Route name
- $data : array<string|int, mixed> = []
-
Named argument replacement data
- $queryParams : array<string|int, mixed> = []
-
Optional query string parameters
Tags
Return values
string —urlFor()
Build the path for a named route including the base path
public
urlFor(string $routeName[, array<string|int, mixed> $data = [] ][, array<string|int, mixed> $queryParams = [] ]) : string
Parameters
- $routeName : string
-
Route name
- $data : array<string|int, mixed> = []
-
Named argument replacement data
- $queryParams : array<string|int, mixed> = []
-
Optional query string parameters