phpDocumentor

RouteParser
in

Interface RouteParser

Table of Contents

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

Methods

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

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
throws
RuntimeException

If named route does not exist

throws
InvalidArgumentException

If required data not provided

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

Tags
throws
RuntimeException

If named route does not exist

throws
InvalidArgumentException

If required data not provided

Return values
string —

Search results