UrlGenerator

класс UrlGenerator реализует UrlGenerator (View source)

Черты

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected RouteCollection	$routes	Коллекция маршрутов.
protected Request	$request	Экземпляр запроса.
protected string	$forcedRoot	Принудительный корневой URL.
protected string	$forceSchema	Принудительная схема для URL-адресов.
protected string\|null	$cachedRoot	Кэшированная копия корневого URL для текущего запроса.
protected string\|null	$cachedSchema	Кэшированная копия схемы URL для текущего запроса.
protected string	$rootNamespace	Корневое пространство имён, применяемое к действиям контроллера.
protected callable	$sessionResolver	Вызываемый объект для разрешения сессии.
protected array	$dontEncode	Символы, которые не должны быть закодированы в URL.

Методы

static void	macro(string $name, callable $macro) Зарегистрировать пользовательский макрос.	из Macroable
static bool	hasMacro(string $name) Проверяет, зарегистрирован ли макрос.	из Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обрабатывает вызовы класса.	из Macroable
mixed	__call(string $method, array $parameters) Динамически обрабатывает вызовы класса.	из Macroable
void	__construct(RouteCollection $routes, Request $request) Создать новый экземпляр генератора URL.
string	full() Получить полный URL для текущего запроса.
string	current() Получить текущий URL для запроса.
string	previous() Получить URL для предыдущего запроса.
string	to(string $path, mixed $extra = [], bool $secure = null) Сгенерировать абсолютный URL для данного пути.
string	secure(string $path, array $parameters = []) Сгенерировать защищенный, абсолютный URL для данного пути.
string	asset(string $path, bool $secure = null) Сгенерировать URL для ресурса приложения.
string	assetFrom(string $root, string $path, bool\|null $secure = null) Сгенерировать URL для ресурса из пользовательского корневого домена, такого как CDN и т.д.
string	removeIndex(string $root) Удалить файл index.php из пути.
string	secureAsset(string $path) Сгенерировать URL для защищенного ресурса.
string	getScheme(bool\|null $secure) Получить схему для необработанного URL.
void	forceSchema(string $schema) Принудительно установить схему для URL.
string	route(string $name, mixed $parameters = [], bool $absolute = true) Получить URL для именованного маршрута.
string	toRoute(Route $route, mixed $parameters, bool $absolute) Получить URL для данного экземпляра маршрута.
string	replaceRoot(Route $route, string $domain, array $parameters) Заменить параметры на корневом пути.
string	replaceRouteParameters(string $path, array $parameters) Заменить все параметры подстановки для пути маршрута.
string	replaceNamedParameters(string $path, array $parameters) Заменить все именованные параметры в пути.
mixed\|string	addQueryString(string $uri, array $parameters) Добавить строку запроса к URI.
array	formatParameters(mixed\|array $parameters) Отформатировать массив параметров URL.
array	replaceRoutableParameters(array $parameters = []) Заменить параметры UrlRoutable на их параметр маршрута.
string	getRouteQueryString(array $parameters) Получить строку запроса для данного маршрута.
array	getStringParameters(array $parameters) Получить строковые параметры из данного списка.
array	getNumericParameters(array $parameters) Получить числовые параметры из данного списка.
string	getRouteDomain(Route $route, array $parameters) Получить отформатированный домен для данного маршрута.
string	formatDomain(Route $route, array $parameters) Отформатировать домен и порт для маршрута и запроса.
string	getDomainAndScheme(Route $route) Получить домен и схему для маршрута.
string	addPortToDomain(string $domain) Добавить порт к домену, если необходимо.
string	getRouteRoot(Route $route, string $domain) Получить корень URL маршрута.
string	getRouteScheme(Route $route) Получить схему для данного маршрута.
string	action(string $action, mixed $parameters = [], bool $absolute = true) Получить URL для действия контроллера.
string	getRootUrl(string $scheme, string $root = null) Получить базовый URL для запроса.
void	forceRootUrl(string $root) Установить принудительный базовый URL.
bool	isValidUrl(string $path) Определить, является ли данный путь допустимым URL.
string	trimUrl(string $root, string $path, string $tail = '') Отформатировать данные сегменты URL в один URL.
Request	getRequest() Получить экземпляр запроса.
void	setRequest(Request $request) Установить текущий экземпляр запроса.
$this	setRoutes(RouteCollection $routes) Установить коллекцию маршрутов.
string\|null	getPreviousUrlFromSession() Получить предыдущий URL из сессии, если возможно.
Store\|null	getSession() Получить реализацию сессии из решателя.

$this	setSessionResolver(callable $sessionResolver) Установить решатель сессии для генератора.
$this	setRootControllerNamespace(string $rootNamespace) Установить корневое пространство имен контроллера.

Подробности

static void macro(string $name, callable $macro)

Зарегистрировать пользовательский макрос.

Параметры

string	$name
callable	$macro

Возвращаемое значение

void

static bool hasMacro(string $name)

Проверяет, зарегистрирован ли макрос.

Параметры

string

$name

Возвращаемое значение

bool

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Параметры

string	$method
array	$parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Параметры

string	$method
array	$parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

void __construct(RouteCollection $routes, Request $request)

Создать новый экземпляр генератора URL.

Параметры

RouteCollection	$routes
Request	$request

Возвращаемое значение

void

string full()

Получить полный URL для текущего запроса.

Возвращаемое значение

string

string current()

Получить текущий URL для запроса.

Возвращаемое значение

string

string previous()

Получить URL для предыдущего запроса.

Возвращаемое значение

string

string to(string $path, mixed $extra = [], bool $secure = null)

Сгенерировать абсолютный URL для заданного пути.

Параметры

string	$path
mixed	$extra
bool	$secure

Возвращаемое значение

string

string secure(string $path, array $parameters = [])

Сгенерировать защищенный, абсолютный URL для заданного пути.

Параметры

string	$path
array	$parameters

Возвращаемое значение

string

string asset(string $path, bool $secure = null)

Сгенерировать URL для ресурса приложения.

Параметры

string	$path
bool	$secure

Возвращаемое значение

string

string assetFrom(string $root, string $path, bool|null $secure = null)

Сгенерировать URL для ресурса из пользовательского корневого домена, такого как CDN и т.д.

Параметры

string	$root
string	$path
bool\|null	$secure

Возвращаемое значение

string

protected string removeIndex(string $root)

Удалить файл index.php из пути.

Параметры

string

$root

Возвращаемое значение

string

string secureAsset(string $path)

Сгенерировать URL для защищенного ресурса.

Параметры

string

$path

Возвращаемое значение

string

protected string getScheme(bool|null $secure)

Получить схему для необработанного URL.

Параметры

bool|null

$secure

Возвращаемое значение

string

void forceSchema(string $schema)

Принудительно задать схему для URL.

Параметры

string

$schema

Возвращаемое значение

void

string route(string $name, mixed $parameters = [], bool $absolute = true)

Получить URL для именованного маршрута.

Параметры

string	$name
mixed	$parameters
bool	$absolute

Возвращаемое значение

string

Исключения

InvalidArgumentException

protected string toRoute(Route $route, mixed $parameters, bool $absolute)

Получить URL для заданного экземпляра маршрута.

Параметры

Route	$route
mixed	$parameters
bool	$absolute

Возвращаемое значение

string

protected string replaceRoot(Route $route, string $domain, array $parameters)

Заменить параметры на корневом пути.

Параметры

Route	$route
string	$domain
array	$parameters

Возвращаемое значение

string

protected string replaceRouteParameters(string $path, array $parameters)

Замените все параметры подстановочных знаков для пути маршрута.

Parameters

string	$path
array	$parameters

Return Value

string

protected string replaceNamedParameters(string $path, array $parameters)

Замените все именованные параметры в пути.

Parameters

string	$path
array	$parameters

Return Value

string

protected mixed|string addQueryString(string $uri, array $parameters)

Добавьте строку запроса к URI.

Parameters

string	$uri
array	$parameters

Return Value

mixed|string

protected array formatParameters(mixed|array $parameters)

Отформатируйте массив параметров URL.

Parameters

mixed|array

$parameters

Return Value

array

protected array replaceRoutableParameters(array $parameters = [])

Замените параметры UrlRoutable на их параметр маршрута.

Parameters

array

$parameters

Return Value

array

protected string getRouteQueryString(array $parameters)

Получите строку запроса для заданного маршрута.

Parameters

array

$parameters

Return Value

string

protected array getStringParameters(array $parameters)

Получите строковые параметры из заданного списка.

Parameters

array

$parameters

Return Value

array

protected array getNumericParameters(array $parameters)

Получите числовые параметры из заданного списка.

Parameters

array

$parameters

Return Value

array

protected string getRouteDomain(Route $route, array $parameters)

Получите отформатированный домен для заданного маршрута.

Parameters

Route	$route
array	$parameters

Return Value

string

protected string formatDomain(Route $route, array $parameters)

Отформатируйте домен и порт для маршрута и запроса.

Parameters

Route	$route
array	$parameters

Return Value

string

protected string getDomainAndScheme(Route $route)

Получите домен и схему для маршрута.

Parameters

Route

$route

Return Value

string

protected string addPortToDomain(string $domain)

При необходимости добавьте порт к домену.

Parameters

string

$domain

Return Value

string

protected string getRouteRoot(Route $route, string $domain)

Получите корень URL-адреса маршрута.

Parameters

Route	$route
string	$domain

Return Value

string

protected string getRouteScheme(Route $route)

Получите схему для заданного маршрута.

Parameters

Route

$route

Return Value

string

string action(string $action, mixed $parameters = [], bool $absolute = true)

Получите URL-адрес для действия контроллера.

Parameters

string	$action
mixed	$parameters
bool	$absolute

Return Value

string

Exceptions

InvalidArgumentException

protected string getRootUrl(string $scheme, string $root = null)

Получите базовый URL для запроса.

Parameters

string	$scheme
string	$root

Return Value

string

void forceRootUrl(string $root)

Установите принудительный базовый URL.

Parameters

string

$root

Return Value

void

bool isValidUrl(string $path)

Определите, является ли заданный путь допустимым URL-адресом.

Parameters

string

$path

Return Value

bool

protected string trimUrl(string $root, string $path, string $tail = '')

Отформатируйте заданные сегменты URL в один URL.

Parameters

string	$root
string	$path
string	$tail

Return Value

string

Request getRequest()

Получите экземпляр запроса.

Return Value

Request

void setRequest(Request $request)

Установить текущий экземпляр запроса.

Parameters

Request

$request

Return Value

void

$this setRoutes(RouteCollection $routes)

Установить коллекцию маршрутов.

Parameters

RouteCollection

$routes

Return Value

$this

protected string|null getPreviousUrlFromSession()

Получить предыдущий URL-адрес из сессии, если это возможно.

Return Value

string|null

protected Store|null getSession()

Получить реализацию сессии из решателя.

Return Value

Store|null

$this setSessionResolver(callable $sessionResolver)

Установить решатель сессии для генератора.

Parameters

callable

$sessionResolver

Return Value

$this

$this setRootControllerNamespace(string $rootNamespace)

Установить корневое пространство имен контроллера.

Parameters

string

$rootNamespace

Return Value

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Routing/UrlGenerator.html