UrlGenerator
класс UrlGenerator реализует UrlGenerator (View source)
Трейты
| InteractsWithTime | |
| Macroable |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищённый RouteCollection | $routes | Коллекция маршрутов. | |
| защищённый Request | $request | Экземпляр запроса. | |
| защищённая строка | $assetRoot | URL корня активов. | |
| защищённая строка | $forcedRoot | Принудительный корень URL. | |
| защищённая строка | $forceScheme | Принудительный протокол для URL. | |
| защищённая строка|null | $cachedRoot | Кэшированная копия корня URL для текущего запроса. | |
| защищённая строка|null | $cachedScheme | Кэшированная копия протокола URL для текущего запроса. | |
| защищённая строка | $rootNamespace | Корневой namespace, применяемый к действиям контроллеров. | |
| защищённый вызов | $sessionResolver | Вызов для получения сессии. | |
| защищённый вызов | $keyResolver | Вызов для получения ключа шифрования. | |
| защищённый Closure | $formatHostUsing | Обратный вызов для форматирования хостов. | |
| защищённый Closure | $formatPathUsing | Обратный вызов для форматирования путей. | |
| защищённый 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 timestamp. | from InteractsWithTime |
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс. | 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, 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 | 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 $scheme)
Принудительно задать схему для 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)
Получить количество секунд до указанной даты и времени.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить отметку времени "доступно в" в формате UNIX timestamp.
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 mixed __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
void __construct(RouteCollection $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)
Создать временный URL подписанного маршрута для именованного маршрута.
bool hasValidSignature(Request $request, bool $absolute = true)
Определить, имеет ли данный запрос действительную подпись.
bool hasCorrectSignature(Request $request, bool $absolute = true)
Определить, соответствует ли подпись из данного запроса URL.
bool signatureHasNotExpired(Request $request)
Определить, не является ли отметка о сроке действия из данного запроса из прошлого.
string route(string $name, mixed $parameters = [], bool $absolute = true)
Получить URL по именованному маршруту.
строка toRoute(Маршрут $route, смешанный тип $parameters, булево $absolute)
Получить URL для данного экземпляра маршрута.
строка action(строка|массив $action, смешанный тип $parameters = [], булево $absolute = true)
Получить URL для действия контроллера.
защищённый строка formatAction(строка|массив $action)
Форматировать заданное действие контроллера.
массив formatParameters(смешанный тип|массив $parameters)
Форматировать массив параметров URL.
защищённый массив extractQueryString(строка $path)
Извлечь строку запроса из заданного пути.
строка formatRoot(строка $scheme, строка|null $root = null)
Получить базовый URL для запроса.
строка format(строка $root, строка $path, Маршрут|null $route = null)
Форматировать заданные сегменты URL в один URL.
булево isValidUrl(строка $path)
Определить, является ли заданный путь допустимым URL.
защищённый RouteUrlGenerator routeUrl()
Получить экземпляр генератора URL маршрута.
пустое значение defaults(массив $defaults)
Установить значения по умолчанию для именованных параметров, используемых генератором URL.
массив getDefaultParameters()
Получить значения по умолчанию для именованных параметров, используемых генератором URL.
пустое значение forceScheme(строка $scheme)
Принудительно установить схему для URL.
пустое значение forceRootUrl(строка $root)
Установить принудительный корневой URL.
$this formatHostUsing(Closure $callback)
Установить обратный вызов для форматирования хоста сгенерированных URL.
$this formatPathUsing(Closure $callback)
Установить обратный вызов для форматирования пути сгенерированных URL.
Closure pathFormatter()
Получить форматировщик пути, используемый генератором URL.
Запрос getRequest()
Получить экземпляр запроса.
пустое значение setRequest(Запрос $request)
Установить текущий экземпляр запроса.
$this setRoutes(RouteCollection $routes)
Установить коллекцию маршрутов.
защищённый Хранилище|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/6.x/Illuminate/Routing/UrlGenerator.html
