1. class
  2. mako
  3. \
  4. http
  5. \
  6. routing
  7. \
  8. URLBuilder

URLBuilder

class URLBuilder

URL builder.

Properties

protected Request $request Request instance.
protected Routes $routes Route collection.
protected bool $cleanURLs Create "clean" URLs?
protected string $baseURL Base URL.
protected string $scriptName Script name.
protected string $languagePrefix Language prefix.

Methods

__construct(Request $request, Routes $routes, bool $cleanURLs = false, string|null $baseURL = null)

Constructor.

bool
matches(string $pattern)

Returns TRUE if the pattern matches the current route and FALSE if not.

string
base()

Returns the base URL of the application.

string
to(string $path, array $queryParams = [], string $separator = '&', mixed $language = true)

Returns the URL of the specified path.

string
toRoute(string $routeName, array $routeParams = [], array $queryParams = [], string $separator = '&', mixed $language = true)

Returns the URL of a named route.

string
current(array|null $queryParams = [], string $separator = '&', mixed $language = true)

Returns the current URL of the request.

string
toLanguage(string $route, mixed $language, array $queryParams = [], string $separator = '&')

Returns the URL of the specified route.

string
toRouteLanguage(string $routeName, string $language, array $routeParams = [], array $queryParams = [], string $separator = '&')

Returns the URL of a named route.

string
currentLanguage(string $language, array|null $queryParams = [], string $separator = '&')

Returns the current URL of the request.

Details

at line 74
__construct(Request $request, Routes $routes, bool $cleanURLs = false, string|null $baseURL = null)

Constructor.

Parameters

Request $request Request instance
Routes $routes Route collection
bool $cleanURLs Create "clean" URLs?
string|null $baseURL Base URL

at line 98
bool matches(string $pattern)

Returns TRUE if the pattern matches the current route and FALSE if not.

Parameters

string $pattern Pattern to match

Return Value

bool

at line 108
string base()

Returns the base URL of the application.

Return Value

string

at line 122
string to(string $path, array $queryParams = [], string $separator = '&', mixed $language = true)

Returns the URL of the specified path.

Parameters

string $path Path
array $queryParams Associative array used to build URL-encoded query string
string $separator Argument separator
mixed $language Request language

Return Value

string

at line 144
string toRoute(string $routeName, array $routeParams = [], array $queryParams = [], string $separator = '&', mixed $language = true)

Returns the URL of a named route.

Parameters

string $routeName Route name
array $routeParams Route parameters
array $queryParams Associative array used to build URL-encoded query string
string $separator Argument separator
mixed $language Request language

Return Value

string

at line 174
string current(array|null $queryParams = [], string $separator = '&', mixed $language = true)

Returns the current URL of the request.

Parameters

array|null $queryParams Associative array used to build URL-encoded query string
string $separator Argument separator
mixed $language Request language

Return Value

string

at line 190
string toLanguage(string $route, mixed $language, array $queryParams = [], string $separator = '&')

Returns the URL of the specified route.

Parameters

string $route URL segments
mixed $language Request language
array $queryParams Associative array used to build URL-encoded query string
string $separator Argument separator

Return Value

string

at line 205
string toRouteLanguage(string $routeName, string $language, array $routeParams = [], array $queryParams = [], string $separator = '&')

Returns the URL of a named route.

Parameters

string $routeName Route name
string $language Request language
array $routeParams Route parameters
array $queryParams Associative array used to build URL-encoded query string
string $separator Argument separator

Return Value

string

at line 218
string currentLanguage(string $language, array|null $queryParams = [], string $separator = '&')

Returns the current URL of the request.

Parameters

string $language Request language
array|null $queryParams Query parameters
string $separator Argument separator

Return Value

string