UrlGenerator

class UrlGenerator implements UrlGenerator (View source)

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	from 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 = 0) Получить метку времени UNIX "доступно в".	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 = null) Получить схему по умолчанию для необработанного URL.
string	signedRoute(string $name, array $parameters = [], DateTimeInterface\|int $expiration = null, bool $absolute = true) Создать подписанный URL маршрута для именованного маршрута.
string	temporarySignedRoute(string $name, DateTimeInterface\|int $expiration, array $parameters = [], bool $absolute = true) Создать временный подписанный 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\|array $action, mixed $parameters = [], bool $absolute = true) Получить URL для действия контроллера.
string	formatAction(string\|array $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, Route\|null $route = null) Отформатировать заданные сегменты URL в один URL.
bool	isValidUrl(string $path) Определить, является ли данный путь допустимым URL.
RouteUrlGenerator	routeUrl() Получить экземпляр генератора URL маршрута.
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-адресов.
Запрос	getRequest() Получить экземпляр запроса.
void	setRequest(Запрос $request) Установить текущий экземпляр запроса.
$this	setRoutes(RouteCollection $routes) Установить коллекцию маршрутов.
Хранилище\|null	getSession() Получить реализацию сессии из решателя.
$this	setSessionResolver(callable $sessionResolver) Установить решатель сессий для генератора.
$this	setKeyResolver(callable $keyResolver) Установить решатель ключей шифрования.
$this	setRootControllerNamespace(string $rootNamespace) Установить корневой пространство имён контроллеров.

Подробности

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

Получить отметку времени UNIX "доступно в".

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

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

Return Value

int

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

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

static void mixin(object $mixin)

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

Parameters

object

$mixin

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string

$name

Return Value

bool

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

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(RouteCollection $routes, Запрос $request)

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

Parameters

RouteCollection	$routes
Запрос	$request

Return Value

void

string full()

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

Return Value

string

string current()

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

Return Value

string

string previous(mixed $fallback = false)

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

Parameters

mixed

$fallback

Return Value

string

protected string|null getPreviousUrlFromSession()

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

Return Value

string|null

END_OF_DOCUMENT_MARKER

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 secureAsset(string $path)

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

Параметры

string

$path

Значение возврата

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 formatScheme(bool|null $secure = null)

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

Параметры

bool|null

$secure

Значение возврата

string

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

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

Параметры

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

Значение возврата

string

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

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

Параметры

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

Значение возврата

string

bool hasValidSignature(Request $request)

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

Параметры

Request

$request

Значение возврата

bool

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

Исключения

UrlGenerationException

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

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

Параметры

string\|array	$action
mixed	$parameters
bool	$absolute

Значение возврата

string

Исключения

InvalidArgumentException

protected string formatAction(string|array $action)

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

Параметры

string|array

$action

Значение возврата

string

array formatParameters(mixed|array $parameters)

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

Параметры

mixed|array

$parameters

Значение возврата

array

protected array extractQueryString(string $path)

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

Параметры

string

$path

Значение возврата

array

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

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

Параметры

string	$scheme
string	$root

Значение возврата

string

string format(string $root, string $path, Маршрут|null $route = null)

Форматировать указанные сегменты URL в один URL.

Параметры

string	$root
string	$path
Маршрут\|null	$route

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

string

bool isValidUrl(string $path)

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

Параметры

string

$path

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

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

Запрос getRequest()

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

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

Запрос

void setRequest(Запрос $request)

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

Параметры

Запрос

$request

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

void

$this setRoutes(RouteCollection $routes)

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

Параметры

RouteCollection

$routes

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

$this

protected Хранилище|null getSession()

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

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

Хранилище|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.7/Illuminate/Routing/UrlGenerator.html