Генератор URL

__construct(RouteCollection $routes, RequestContext $context, LoggerInterface $logger = null)

Параметры

RouteCollection	$routes
RequestContext	$context
LoggerInterface	$logger

setContext(RequestContext $context)

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

Параметры

RequestContext

$context

RequestContext getContext()

Получает контекст запроса.

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

RequestContext

Контекст

setStrictRequirements(bool|null $enabled)

Включает или отключает исключение при неправильных параметрах.

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

Параметры

bool|null

$enabled

bool|null isStrictRequirements()

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

Null означает, что проверка требований полностью деактивирована.

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

bool|null

string generate(string $name, mixed $parameters = array(), int $referenceType = self::ABSOLUTE_PATH)

Генерирует URL или путь для конкретного маршрута на основе заданных параметров.

Параметры, ссылающиеся на заполнитель в шаблоне маршрута, заменят их в пути или имени хоста. Дополнительные параметры добавляются в строку запроса к URL.

Если тип ссылки, который требуется сгенерировать, не может быть создан для маршрута, так как он требует другого хоста или схемы, чем текущий, метод вернёт более полную ссылку, которая включает необходимые параметры. Например, при вызове этого метода с $referenceType = ABSOLUTE_PATH, но маршрут требует схемы https, а текущая схема - http, он вернёт ABSOLUTE_URL со схемой https и текущим хостом. Это гарантирует, что сгенерированный URL соответствует маршруту в любом случае.

Если маршрута с заданным именем нет, генератор должен сгенерировать исключение RouteNotFoundException.

Специальный параметр _fragment будет использоваться как фрагмент документа, присоединённый к конечному URL.

Параметры

string	$name	Имя маршрута
mixed	$parameters	Массив параметров
int	$referenceType	Тип ссылки, которая должна быть сгенерирована (одна из констант)

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

string

Сгенерированный URL

Исключения

RouteNotFoundException	Если заданного маршрута не существует
MissingMandatoryParametersException	Если отсутствуют обязательные параметры маршрута
InvalidParameterException	Если значение параметра для заполнителя не соответствует требованиям

static string getRelativePath(string $basePath, string $targetPath)

Возвращает целевой путь как относительную ссылку от базового пути.

Только компонент пути URI (без схемы, хоста и т.д.) имеет значение и должен быть задан, начиная с косой черты. Оба пути должны быть абсолютными и не должны содержать относительных частей. Относительные URL от одного ресурса к другому полезны при генерации автономных загружаемых архивов документов. Кроме того, они могут использоваться для уменьшения размера ссылок в документах.

Примеры целевых путей, при базовом пути "/a/b/c/d": - "/a/b/c/d" -> "" - "/a/b/c/" -> "./" - "/a/b/" -> "../" - "/a/b/c/other" -> "other" - "/a/x/y" -> "../../x/y"

Параметры

string	$basePath	Базовый путь
string	$targetPath	Целевой путь

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

string

Относительный целевой путь