UrlGenerator

class UrlGenerator implements UrlGenerator (View source)

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected RouteCollection	$routes	Коллекция маршрутов.
protected Request	$request	Экземпляр запроса.
protected string	$forcedRoot	Принудительный корень URL.
protected string	$forceScheme	Принудительная схема для URL-адресов.
protected string\|null	$cachedRoot	Кэшированная копия корня URL для текущего запроса.
protected string\|null	$cachedSchema	Кэшированная копия схемы URL для текущего запроса.
protected string	$rootNamespace	Корневое пространство имён, применяемое к действиям контроллера.
protected callable	$sessionResolver	Вызываемая функция для разрешения сессии.
protected callable	$keyResolver	Вызываемая функция для разрешения ключа шифрования.
protected Closure	$formatHostUsing	Обратный вызов для форматирования хостов.
protected Closure	$formatPathUsing	Обратный вызов для форматирования путей.
protected RouteUrlGenerator\|null	$routeGenerator	Экземпляр генератора URL маршрутов.

Методы

int	secondsUntil(DateTimeInterface\|DateInterval\|int $delay) Получить количество секунд до заданной даты DateTime.	from InteractsWithTime
int	availableAt(DateTimeInterface\|DateInterval\|int $delay) Получить метку времени UNIX "доступно в" (available at).	from InteractsWithTime
DateTimeInterface\|int	parseDateInterval(DateTimeInterface\|DateInterval\|int $delay) Если заданное значение представляет собой интервал, преобразовать его в экземпляр DateTime.	from InteractsWithTime
int	currentTime() Получить текущее системное время в формате метки времени UNIX.	from InteractsWithTime
static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательское макро.	from Macroable
static void	mixin(object $mixin) Включить другой объект в класс.	from Macroable
static bool	hasMacro(string $name) Проверяет, зарегистрировано ли макро.	from Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обрабатывать вызовы класса.	from Macroable
mixed	__call(string $method, array $parameters) Динамически обрабатывать вызовы класса.	from Macroable
void	__construct(RouteCollection $routes, Request $request) Создать новый экземпляр генератора URL.
string	full() Получить полный URL для текущего запроса.
string	current() Получить текущий URL для запроса.
string	previous(mixed $fallback = false) Получить URL предыдущего запроса.
string\|null	getPreviousUrlFromSession() Получить предыдущий 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	secureAsset(string $path) Сгенерировать URL для защищенного ресурса.
string	assetFrom(string $root, string $path, bool\|null $secure = null) Сгенерировать URL для ресурса из пользовательского корневого домена, такого как CDN и т.д.
string	removeIndex(string $root) Удалить файл index.php из пути.
string	formatScheme(bool\|null $secure) Получить стандартную схему для простого URL.
string	signedRoute(string $name, array $parameters = [], DateTimeInterface\|int $expiration = null) Создать подписанный URL маршрута для именованного маршрута.
string	temporarySignedRoute(string $name, DateTimeInterface\|int $expiration, array $parameters = []) Создать временный подписанный URL маршрута для именованного маршрута.
bool	hasValidSignature(Request $request) Определить, имеет ли данный запрос действительную подпись.
string	route(string $name, mixed $parameters = [], bool $absolute = true) Получить URL для именованного маршрута.
string	toRoute(Route $route, mixed $parameters, bool $absolute) Получить URL для данного экземпляра маршрута.
string	action(string $action, mixed $parameters = [], bool $absolute = true) Получить URL для действия контроллера.
string	formatAction(string $action) Отформатировать заданное действие контроллера.
array	formatParameters(mixed\|array $parameters) Отформатировать массив параметров URL.
array	extractQueryString(string $path) Извлечь строку запроса из заданного пути.
string	formatRoot(string $scheme, string $root = null) Получить базовый URL для запроса.
string	format(string $root, string $path) Отформатировать заданные сегменты URL в единый URL.
bool	isValidUrl(string $path) Определить, является ли заданный путь допустимым URL.
RouteUrlGenerator	routeUrl() Получить экземпляр генератора URL Route.
void	defaults(array $defaults) Установить параметры по умолчанию для именованных параметров, используемых генератором URL.
array	getDefaultParameters() Получить параметры по умолчанию для именованных параметров, используемых генератором URL.
void	forceScheme(string $schema) Принудительно установить схему для URL.
void	forceRootUrl(string $root) Установить принудительно корневой URL.
$this	formatHostUsing(Closure $callback) Установить обратный вызов для форматирования хоста сгенерированных URL.

$this	formatPathUsing(Closure $callback) Установить обратный вызов для форматирования пути сгенерированных URL-адресов.
Closure	pathFormatter() Получить используемый форматировщик путей для генератора URL-адресов.
Request	getRequest() Получить экземпляр запроса.
void	setRequest(Request $request) Установить текущий экземпляр запроса.
$this	setRoutes(RouteCollection $routes) Установить коллекцию маршрутов.
Store\|null	getSession() Получить реализацию сессии из резолвера.
$this	setSessionResolver(callable $sessionResolver) Установить резолвер сессии для генератора.
$this	setKeyResolver(callable $keyResolver) Установить резолвер ключа шифрования.
$this	setRootControllerNamespace(string $rootNamespace) Установить корневое пространство имён контроллеров.

Подробности

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay)

Получить метку времени «доступно в» в формате UNIX.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

protected int currentTime()

Получить текущее системное время в формате UNIX timestamp.

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

int

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

Зарегистрировать пользовательскую макрокоманду.

Параметры

string	$name
object\|callable	$macro

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

void

static void mixin(object $mixin)

Добавить другой объект в класс.

Параметры

object

$mixin

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

void

Исключения

ReflectionException

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(mixed $fallback = false)

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

Параметры

mixed

$fallback

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

string

protected string|null getPreviousUrlFromSession()

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

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

string|null

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

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

Параметры

string	$path
mixed	$extra
bool	$secure

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

string

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

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

Parameters

string	$path
array	$parameters

Return Value

string

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

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

Parameters

string	$path
bool	$secure

Return Value

string

string secureAsset(string $path)

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

Parameters

string

$path

Return Value

string

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

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

Parameters

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

Return Value

string

protected string removeIndex(string $root)

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

Parameters

string

$root

Return Value

string

string formatScheme(bool|null $secure)

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

Parameters

bool|null

$secure

Return Value

string

string signedRoute(string $name, array $parameters = [], DateTimeInterface|int $expiration = null)

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

Parameters

string	$name
array	$parameters
DateTimeInterface\|int	$expiration

Return Value

string

string temporarySignedRoute(string $name, DateTimeInterface|int $expiration, array $parameters = [])

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

Parameters

string	$name
DateTimeInterface\|int	$expiration
array	$parameters

Return Value

string

bool hasValidSignature(Request $request)

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

Parameters

Request

$request

Return Value

bool

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

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

Parameters

string	$name
mixed	$parameters
bool	$absolute

Return Value

string

Exceptions

InvalidArgumentException

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

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

Parameters

Route	$route
mixed	$parameters
bool	$absolute

Return Value

string

Exceptions

UrlGenerationException

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

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

Parameters

string	$action
mixed	$parameters
bool	$absolute

Return Value

string

Exceptions

InvalidArgumentException

protected string formatAction(string $action)

Отформатировать данное действие контроллера.

Parameters

string

$action

Return Value

string

array formatParameters(mixed|array $parameters)

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

Parameters

mixed|array

$parameters

Return Value

array

protected array extractQueryString(string $path)

Извлечь строку запроса из данного пути.

Parameters

string

$path

Return Value

array

string formatRoot(string $scheme, string $root = null)

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

Parameters

string	$scheme
string	$root

Return Value

string

string format(string $root, string $path)

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

Parameters

string	$root
string	$path

Return Value

string

bool isValidUrl(string $path)

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

Parameters

string

$path

Return Value

bool

protected RouteUrlGenerator routeUrl()

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

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

RouteUrlGenerator

void defaults(array $defaults)

Установить параметры по умолчанию для именованных параметров, используемых генератором URL.

Параметры

array

$defaults

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

void

array getDefaultParameters()

Получить параметры по умолчанию для именованных параметров, используемых генератором URL.

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

array

void forceScheme(string $schema)

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

Параметры

string

$schema

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

void

void forceRootUrl(string $root)

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

Параметры

string

$root

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

void

$this formatHostUsing(Closure $callback)

Установить обратный вызов для форматирования хоста сгенерированных URL-адресов.

Параметры

Closure

$callback

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

$this

$this formatPathUsing(Closure $callback)

Установить обратный вызов для форматирования пути сгенерированных URL-адресов.

Параметры

Closure

$callback

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

$this

Closure pathFormatter()

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

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

Closure

Request getRequest()

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

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

Request

void setRequest(Request $request)

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

Параметры

Request

$request

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

void

$this setRoutes(RouteCollection $routes)

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

Параметры

RouteCollection

$routes

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

$this

protected Store|null getSession()

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

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

Store|null

$this setSessionResolver(callable $sessionResolver)

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

Параметры

callable

$sessionResolver

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

$this

$this setKeyResolver(callable $keyResolver)

Установить решатель ключа шифрования.

Параметры

callable

$keyResolver

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

$this

$this setRootControllerNamespace(string $rootNamespace)

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

Параметры

string

$rootNamespace

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

$this

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