Spec-Zone.ru › Laravel 5.8

UrlGenerator

class UrlGenerator implements UrlGenerator (View source)

Свойства

InteractsWithTime
Macroable

Свойства

static protected array $macros Зарегистрированные макросы строк. from Macroable
protected RouteCollection $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.

 из 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 mixed __callStatic(string $method, array $parameters)

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

 из Macroable
mixed __call(string $method, array $parameters)

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

 из 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, array $parameters = [], DateTimeInterface|DateInterval|int|null $expiration = null, bool $absolute = true)

Создать URL подписанного маршрута для именованного маршрута.
string temporarySignedRoute(string $name, DateTimeInterface|DateInterval|int $expiration, array $parameters = [], bool $absolute = true)

Создать временный URL подписанного маршрута для именованного маршрута.
bool hasValidSignature(Запрос $request, bool $absolute = true)

Определить, имеет ли данный запрос действительную подпись.
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 до действия контроллера.
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, Маршрут|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)

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

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

Получить отметку времени "доступно в" в формате 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.

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

int

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

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

Параметры

string $name
object|callable $macro

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

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object $mixin
bool $replace

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

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, string|null $assetRoot = null)

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

Параметры

RouteCollection $routes
Request $request
string|null $assetRoot

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

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

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

Параметры

string $path
mixed $extra
bool|null $secure

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

string

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

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

Параметры

string $path
array $parameters

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

string

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

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

Параметры

string $path
bool|null $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|DateInterval|int|null $expiration = null, bool $absolute = true)

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

Параметры

string $name
array $parameters
DateTimeInterface|DateInterval|int|null $expiration
bool $absolute

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

string

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

Создать временную подписанную ссылку на маршрут с заданным именем.

Параметры

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

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

string

bool hasValidSignature(Request $request, bool $absolute = true)

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

Параметры

Request $request
bool $absolute

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

bool

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

Получить URL по имени маршрута.

Параметры

string $name
mixed $parameters
bool $absolute

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

string

Исключения

InvalidArgumentException

protected string toRoute(Маршрут $route, mixed $parameters, bool $absolute)

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

Параметры

Маршрут $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|null $root = null)

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

Параметры

string $scheme
string|null $root

Значение результата

string

string format(string $root, string $path, Route|null $route = null)

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

Параметры

string $root
string $path
Route|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 $scheme)

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

Параметры

string $scheme

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

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 Store|null getSession()

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

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

Store|null

$this setSessionResolver(callable $sessionResolver)

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

Параметры

callable $sessionResolver

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

$this

$this setKeyResolver(callable $keyResolver)

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

Параметры

callable $keyResolver

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

$this

$this setRootControllerNamespace(string $rootNamespace)

Установить корневой namespace контроллеров.

Параметры

string $rootNamespace

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

$this

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API