UrlGenerator
класс UrlGenerator реализует UrlGenerator (Просмотреть исходный код)
Трейты
| InteractsWithTime | |
| Macroable |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищённый RouteCollectionInterface | $routes | Коллекция маршрутов. | |
| защищённый Request | $request | Экземпляр запроса. | |
| защищённая строка | $assetRoot | Корневой URL активов. | |
| защищённая строка | $forcedRoot | Принудительный корень URL. | |
| защищённая строка | $forceScheme | Принудительный протокол для URL. | |
| защищённая строка|null | $cachedRoot | Кэшированная копия корня URL для текущего запроса. | |
| защищённая строка|null | $cachedScheme | Кэшированная копия протокола URL для текущего запроса. | |
| защищённая строка | $rootNamespace | Корневой пространство имён, применяемое к действиям контроллеров. | |
| защищённый вызываемый объект | $sessionResolver | Вызываемый объект для разрешения сессии. | |
| защищённый вызываемый объект | $keyResolver | Вызываемый объект для разрешения ключа шифрования. | |
| защищённый Closure | $formatHostUsing | Обратный вызов для форматирования хостов. | |
| защищённый Closure | $formatPathUsing | Обратный вызов для форматирования путей. | |
| защищённый RouteUrlGenerator|null | $routeGenerator | Экземпляр генератора URL маршрута. |
Методы
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay) Получить количество секунд до заданной даты DateTime. | из InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0) Получить отметку времени UNIX "доступно в" (available at). | из InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay) Если заданное значение является интервалом, преобразовать его в экземпляр DateTime. | из InteractsWithTime |
| int | currentTime() Получить текущее системное время как отметку времени UNIX. | из InteractsWithTime |
| static void | macro(string $name, object|callable $macro) Зарегистрировать пользовательский макрос. | из Macroable |
| static void | mixin(object $mixin, bool $replace = true) Смешать другой объект в класс. | из Macroable |
| static bool | hasMacro(string $name) Проверка, зарегистрирован ли макрос. | из Macroable |
| static void | flushMacros() Очистить существующие макросы. | из Macroable |
| static mixed | __callStatic(string $method, array $parameters) Динамически обработать вызовы к классу. | из Macroable |
| mixed | __call(string $method, array $parameters) Динамически обработать вызовы к классу. | из Macroable |
| void | __construct(RouteCollectionInterface $routes, Request $request, string|null $assetRoot = null) Создать новый экземпляр генератора URL. | |
| string | full() Получить полный URL текущего запроса. | |
| string | current() Получить текущий URL запроса. | |
| string | previous(mixed $fallback = false) Получить URL предыдущего запроса. | |
| string | previousPath(mixed $fallback = false) Получить предыдущий путь для запроса. | |
| string|null | getPreviousUrlFromSession() Получить предыдущий URL из сессии, если возможно. | |
| string | to(string $path, mixed $extra = [], bool|null $secure = null) Сгенерировать абсолютный URL по заданному пути. | |
| string | secure(string $path, array $parameters = []) Сгенерировать защищённый, абсолютный URL по заданному пути. | |
| string | asset(string $path, bool|null $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, mixed $parameters = [], DateTimeInterface|DateInterval|int|null $expiration = null, bool $absolute = true) Создать URL подписанного маршрута по имени маршрута. | |
| void | ensureSignedRouteParametersAreNotReserved(mixed $parameters) Убедиться, что данные подписанного маршрута не являются зарезервированными. | |
| string | temporarySignedRoute(string $name, DateTimeInterface|DateInterval|int $expiration, array $parameters = [], bool $absolute = true) Создать временный URL подписанного маршрута для именованного маршрута. | |
| bool | hasValidSignature(Request $request, bool $absolute = true, array $ignoreQuery = []) Определить, имеет ли данный запрос действительную подпись. | |
| bool | hasValidRelativeSignature(Request $request, array $ignoreQuery = []) Определить, имеет ли данный запрос действительную подпись для относительного URL. | |
| bool | hasCorrectSignature(Request $request, bool $absolute = true, array $ignoreQuery = []) Определить, соответствует ли подпись из данного запроса URL. | |
| bool | signatureHasNotExpired(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|null $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|null $scheme)
Принудительно установить схему для URL. | |
| void | forceRootUrl(string|null $root)
Установить принудительно корневой URL. | |
| $this | formatHostUsing(Closure $callback)
Установить обратный вызов для форматирования хоста сгенерированных URL. | |
| $this | formatPathUsing(Closure $callback)
Установить обратный вызов для форматирования пути сгенерированных URL. | |
| Closure | pathFormatter()
Получить форматировщик пути, используемый генератором URL. | |
| Request | getRequest()
Получить экземпляр запроса. | |
| void | setRequest(Request $request)
Установить текущий экземпляр запроса. | |
| $this | setRoutes(RouteCollectionInterface $routes)
Установить коллекцию маршрутов. | |
| Store|null | getSession()
Получить реализацию сессии из решателя. | |
| $this | setSessionResolver(callable $sessionResolver)
Установить решатель сессии для генератора. | |
| $this | setKeyResolver(callable $keyResolver)
Установить решатель ключа шифрования. | |
| UrlGenerator | withKeyResolver(callable $keyResolver)
Создать новый экземпляр генератора URL с другим решателем ключа шифрования. | |
| string | getRootControllerNamespace()
Получить корневое пространство имён контроллеров. | |
| $this | setRootControllerNamespace(string $rootNamespace)
Установить корневое пространство имён контроллеров. |
Подробности
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до заданной даты DateTime.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить отметку времени UNIX для "доступно в" момент.
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.
protected int currentTime()
Получить текущее системное время в виде отметки времени UNIX.
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательскую макрокоманду.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрирована ли макрокоманда.
static void flushMacros()
Очистить существующие макрокоманды.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы к классу.
mixed __call(string $method, array $parameters)
Динамически обрабатывает вызовы к классу.
void __construct(RouteCollectionInterface $routes, Request $request, string|null $assetRoot = null)
Создаёт новый экземпляр генератора URL.
string full()
Получить полный URL для текущего запроса.
string current()
Получить текущий URL для запроса.
string previous(mixed $fallback = false)
Получить URL для предыдущего запроса.
string previousPath(mixed $fallback = false)
Получить предыдущий путь для запроса.
protected string|null getPreviousUrlFromSession()
Получить предыдущий URL из сессии, если возможно.
string to(string $path, mixed $extra = [], bool|null $secure = null)
Сгенерировать абсолютный URL по заданному пути.
string secure(string $path, array $parameters = [])
Сгенерировать защищённый, абсолютный URL по заданному пути.
string asset(string $path, bool|null $secure = null)
Сгенерировать URL к ресурсу приложения.
string secureAsset(string $path)
Сгенерировать URL к защищённому ресурсу.
string assetFrom(string $root, string $path, bool|null $secure = null)
Сгенерировать URL к ресурсу с пользовательским корневым доменом, например, CDN.
protected string removeIndex(string $root)
Удалить файл index.php из пути.
string formatScheme(bool|null $secure = null)
Получить стандартную схему для сырого URL.
string signedRoute(string $name, mixed $parameters = [], DateTimeInterface|DateInterval|int|null $expiration = null, bool $absolute = true)
Создать подписанный URL маршрута по имени маршрута.
protected void ensureSignedRouteParametersAreNotReserved(mixed $parameters)
Убедиться, что заданные параметры подписанного маршрута не зарезервированы.
string temporarySignedRoute(string $name, DateTimeInterface|DateInterval|int $expiration, array $parameters = [], bool $absolute = true)
Создать временный подписанный URL маршрута по имени маршрута.
bool hasValidSignature(Request $request, bool $absolute = true, array $ignoreQuery = [])
Определить, имеет ли данный запрос действительную подпись.
bool hasValidRelativeSignature(Request $request, array $ignoreQuery = [])
Определить, имеет ли данный запрос действительную подпись для относительного URL.
bool hasCorrectSignature(Request $request, bool $absolute = true, array $ignoreQuery = [])
Определить, соответствует ли подпись из данного запроса URL.
bool signatureHasNotExpired(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 для действия контроллера.
protected string formatAction(string|array $action)
Отформатировать заданное действие контроллера.
array formatParameters(mixed|array $parameters)
Отформатировать массив параметров URL.
protected array extractQueryString(string $path)
Извлечь строку запроса из заданного пути.
string formatRoot(string $scheme, string|null $root = null)
Получить базовый URL для запроса.
string format(string $root, string $path, Route|null $route = null)
Отформатировать заданные сегменты URL в один URL.
bool isValidUrl(string $path)
Определить, является ли заданный путь допустимым URL.
protected RouteUrlGenerator routeUrl()
Получить экземпляр генератора URL маршрутов.
void defaults(array $defaults)
Установить параметры по умолчанию, используемые генератором URL.
array getDefaultParameters()
Получить параметры по умолчанию, используемые генератором URL.
void forceScheme(string|null $scheme)
Принудительно установить схему для URL.
void forceRootUrl(string|null $root)
Установить принудительный URL корня.
$this formatHostUsing(Closure $callback)
Установить обратный вызов для форматирования хоста сгенерированных URL-адресов.
$this formatPathUsing(Closure $callback)
Установить обратный вызов для форматирования пути сгенерированных URL-адресов.
Closure pathFormatter()
Получить используемый форматировщик путей для генератора URL-адресов.
Request getRequest()
Получить экземпляр запроса.
void setRequest(Request $request)
Установить текущий экземпляр запроса.
$this setRoutes(RouteCollectionInterface $routes)
Установить коллекцию маршрутов.
protected Store|null getSession()
Получить реализацию сессии из разрешителя.
$this setSessionResolver(callable $sessionResolver)
Установить разрешитель сессий для генератора.
$this setKeyResolver(callable $keyResolver)
Установить разрешитель ключа шифрования.
UrlGenerator withKeyResolver(callable $keyResolver)
Создать новый экземпляр генератора URL-адресов с другим разрешителем ключа шифрования.
string getRootControllerNamespace()
Получить корневое пространство имён контроллеров.
$this setRootControllerNamespace(string $rootNamespace)
Установить корневое пространство имён контроллеров.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Routing/UrlGenerator.html
