UrlGenerator
class UrlGenerator implements UrlGenerator (View source)
Свойства
| InteractsWithTime | |
| Macroable |
Свойства
| static protected array | $macros | Зарегистрированные строковые макросы. | from Macroable |
| protected RouteCollectionInterface | $routes | Коллекция маршрутов. | |
| protected Request | $request | Экземпляр запроса. | |
| protected string | $assetRoot | URL корня активов. | |
| protected string | $forcedRoot | Принудительный корень URL. | |
| protected string | $forceScheme | Принудительный протокол для URL. | |
| protected string|null | $cachedRoot | Кэшированная копия корня URL для текущего запроса. | |
| protected string|null | $cachedScheme | Кэшированная копия схемы 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. | из InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить метку времени «доступно в» в формате UNIX. | из InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime. | из InteractsWithTime |
| int | currentTime()
Получить текущее системное время в формате UNIX timestamp. | из InteractsWithTime |
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос. | из Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс. | из Macroable |
| static bool | hasMacro(string $name)
Проверяет, зарегистрирован ли макрос. | from Macroable |
| static void | flushMacros()
Очистить существующие макросы. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы к классу. | from Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обрабатывает вызовы к классу. | from 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|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)
Определить, имеет ли данный запрос действительную подпись. | |
| bool | hasValidRelativeSignature(Request $request)
Определить, имеет ли данный запрос действительную подпись для относительного URL. | |
| bool | hasCorrectSignature(Request $request, bool $absolute = true)
Определить, соответствует ли подпись из данного запроса 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)
Установить резолвер ключа шифрования. | |
| $this | setRootControllerNamespace(string $rootNamespace)
Установить корневое пространство имён контроллеров. |
Подробности
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до заданной даты DateTime.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить метку времени UNIX для "доступно в" (available at).
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.
protected int currentTime()
Получить текущее системное время в формате UNIX timestamp.
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 предыдущего запроса.
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)
Создать временную подписанную ссылку на маршрут с указанным именем.
bool hasValidSignature(Request $request, bool $absolute = true)
Определить, имеет ли данный запрос действительную подпись.
bool hasValidRelativeSignature(Request $request)
Определить, имеет ли данный запрос действительную подпись для относительного URL.
bool hasCorrectSignature(Request $request, bool $absolute = true)
Определить, соответствует ли подпись из данного запроса URL.
bool signatureHasNotExpired(Request $request)
Определить, не истек ли отметка времени истечения срока действия из данного запроса.
string route(string $name, mixed $parameters = [], bool $absolute = true)
Получить URL по именованному маршруту.
string toRoute(Маршрут $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.
Запрос getRequest()
Получить экземпляр запроса.
void setRequest(Запрос $request)
Установить текущий экземпляр запроса.
$this setRoutes(Интерфейс коллекции маршрутов $routes)
Установить коллекцию маршрутов.
protected Store|null getSession()
Получить реализацию сессии из разрешителя.
$this setSessionResolver(callable $sessionResolver)
Установить разрешитель сессии для генератора.
$this setKeyResolver(callable $keyResolver)
Установить разрешитель ключа шифрования.
$this setRootControllerNamespace(string $rootNamespace)
Установить корневое пространство имен контроллеров.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Routing/UrlGenerator.html
