UrlGenerator

class UrlGenerator implements UrlGenerator (View source)

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	из 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 Closure	$formatHostUsing	Обратный вызов для форматирования хостов.
protected Closure	$formatPathUsing	Обратный вызов для форматирования путей.
protected RouteUrlGenerator	$routeGenerator	Экземпляр генератора URL маршрутов.

Методы

static void

macro(string $name, callable $macro)

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

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)

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

string

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

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

string

toRoute(Route $route, mixed $parameters, bool $absolute)

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

string

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

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

string

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

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

bool

isValidUrl(string $path)

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

RouteUrlGenerator

routeUrl()

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

void

defaults(array $defaults)

Установить параметры по умолчанию, используемые генератором URL.

void

forceScheme(string $schema)

Принудительно установить схему для 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

setRootControllerNamespace(string $rootNamespace)

Установить корневое пространство имён контроллеров.

Подробности

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

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

Parameters

string	$name
callable	$macro

Return Value

void

static bool hasMacro(string $name)

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

Parameters

string

$name

Return Value

bool

END_OF_DOCUMENT_MARKER

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)

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

Параметры

RouteCollection	$routes
Request	$request

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

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 $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)

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

Параметры

bool|null

$secure

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

string

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 $action, mixed $parameters = [], bool $absolute = true)

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

Параметры

string	$action
mixed	$parameters
bool	$absolute

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

string

Исключения

InvalidArgumentException

protected string formatAction(string $action)

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

Параметры

string

$action

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

string

array formatParameters(mixed|array $parameters)

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

Параметры

mixed|array

$parameters

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

array

protected array extractQueryString(string $path)

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

Parameters

string

$path

Return Value

array

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

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

Parameters

string	$scheme
string	$root

Return Value

string

string format(string $root, string $path)

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

Parameters

string	$root
string	$path

Return Value

string

bool isValidUrl(string $path)

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

Parameters

string

$path

Return Value

bool

protected RouteUrlGenerator routeUrl()

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

Return Value

RouteUrlGenerator

void defaults(array $defaults)

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

Parameters

array

$defaults

Return Value

void

void forceScheme(string $schema)

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

Parameters

string

$schema

Return Value

void

void forceRootUrl(string $root)

Установить принудительный корневой URL.

Parameters

string

$root

Return Value

void

$this formatHostUsing(Closure $callback)

Установить обратный вызов, который будет использоваться для форматирования хоста сгенерированных URL.

Parameters

Closure

$callback

Return Value

$this

$this formatPathUsing(Closure $callback)

Установить обратный вызов, который будет использоваться для форматирования пути сгенерированных URL.

Parameters

Closure

$callback

Return Value

$this

Closure pathFormatter()

Получить форматировщик пути, используемый генератором URL.

Return Value

Closure

Request getRequest()

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

Return Value

Request

void setRequest(Request $request)

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

Parameters

Request

$request

Return Value

void

$this setRoutes(RouteCollection $routes)

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

Parameters

RouteCollection

$routes

Return Value

$this

protected Store|null getSession()

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

Return Value

Store|null

$this setSessionResolver(callable $sessionResolver)

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

Parameters

callable

$sessionResolver

Return Value

$this

$this setRootControllerNamespace(string $rootNamespace)

Установить корневое пространство имен контроллера.

Parameters

string

$rootNamespace

Return Value

$this

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