Spec-Zone.ru › CakePHP 4.2

Класс RouteCollection

Содержит коллекцию маршрутов.

Предоставляет интерфейс для добавления/удаления маршрутов и разбора/генерации URL с использованием содержащихся в нём маршрутов.

Пространство имён: Cake\Routing

Краткое описание свойств

  • $_extensions protected
    string[]

    Расширения маршрутов

  • $_middleware protected
    array

    Отображение имён middleware и соответствующих объектов.

  • $_middlewareGroups protected
    array

    Отображение имён групп middleware и соответствующих имён middleware.

  • $_named protected
    Cake\Routing\Route\Route[]

    Хэш-карта именованных маршрутов в этой коллекции.

  • $_paths protected
    array<string, arrayCake\Routing\Route\Route>>

    Маршруты, индексированные по префиксу пути.

  • $_routeTable protected
    array

    Маршруты, присоединённые к этой коллекции.

Краткое описание методов

  • _getNames() protected

    Получить набор имён из $url. Поддерживает как старые массивоподобные URL, так и новые URL, содержащие '_name'.

  • add() public

    Добавить маршрут в коллекцию.

  • getExtensions() public

    Получить расширения, которые могут быть обработаны.

  • getMiddleware() public

    Получить массив middleware по списку имён.

  • hasMiddleware() public

    Проверить, зарегистрирован ли middleware с указанным именем.

  • hasMiddlewareGroup() public

    Проверить, создана ли группа middleware с указанным именем.

  • match() public

    Обратный маршрут или сопоставление массива $url с подключёнными маршрутами.

  • middlewareExists() public

    Проверить, зарегистрирован ли middleware или группа middleware с указанным именем.

  • middlewareGroup() public

    Добавить middleware в группу middleware.

  • named() public

    Получить подключённые именованные маршруты.

  • parse() public

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

  • parseRequest() public

    Принимает ServerRequestInterface, итерирует маршруты, пока не найдёт маршрут, подходящий для разбора.

  • registerMiddleware() public

    Зарегистрировать middleware в RouteCollection.

  • routes() public

    Получить все подключённые маршруты в виде плоского списка.

  • setExtensions() public

    Установить расширения, которые может обрабатывать коллекция маршрутов.

END_OF_DOCUMENT_MARKER

Подробное описание методов

_getNames() protected 

_getNames(array $url): string[]

Получить набор имён из $url. Поддерживает как старые стили URL-массивов, так и новые URL-стили, содержащие «_name».

Параметры

array $url

URL для соответствия.

Возвращает

string[]

add() public 

add(Cake\Routing\Route\Route $route, array $options = []): void

Добавить маршрут в коллекцию.

Параметры

Cake\Routing\Route\Route $route

Объект маршрута для добавления.

array $options optional

Дополнительные параметры для маршрута. В основном для параметра _name, который включает именованные маршруты.

Возвращает

void

getExtensions() public 

getExtensions(): string[]

Получить обработчики расширений.

Возвращает

string[]

getMiddleware() public 

getMiddleware(string[] $names): array

Получить массив обработчиков, заданных списком имён.

Параметры

string[] $names

Имена обработчиков или групп для извлечения.

Возвращает

array

Исключения

RuntimeException
при отсутствии запрошенного обработчика.

hasMiddleware() public 

hasMiddleware(string $name): bool

Проверить, зарегистрирован ли обработчик с заданным именем.

Параметры

string $name

Имя обработчика для проверки.

Возвращает

bool

hasMiddlewareGroup() public 

hasMiddlewareGroup(string $name): bool

Проверить, создана ли группа обработчиков с заданным именем.

Параметры

string $name

Имя группы обработчиков для проверки.

Возвращает

bool

match() public 

match(array $url, array $context): string

Обратный маршрут или сопоставление массива $url с подключёнными маршрутами.

Возвращает строку URL, сгенерированную маршрутом, или выбрасывает исключение при ошибке.

Параметры

array $url

URL для сопоставления.

array $context

Контекст запроса для использования. Содержит ключи _base, _port, _host, _scheme и params.

Возвращает

string

Исключения

Cake\Routing\Exception\MissingRouteException
Когда маршрут не был сопоставлен.

middlewareExists() public 

middlewareExists(string $name): bool

Проверить, зарегистрирован ли обработчик или группа обработчиков с заданным именем.

Параметры

string $name

Имя обработчика для проверки.

Возвращает

bool

middlewareGroup() public 

middlewareGroup(string $name, string[] $middlewareNames): $this

Добавить обработчики в группу обработчиков.

Параметры

string $name

Имя группы обработчиков.

string[] $middlewareNames

Имена обработчиков.

Возвращает

$this

Исключения

RuntimeException

named() public 

named(): Cake\Routing\Route\Route[]

Получить подключенные именованные маршруты.

Возвращает

Cake\Routing\Route\Route[]

parse() public 

parse(string $url, string $method = ''): array

Принимает строку URL и итерирует маршруты, пока не сможет разобрать маршрут.

Параметры

string $url

URL для разбора.

string $method optional

HTTP-метод для использования.

Возвращает

array

Исключения

Cake\Routing\Exception\MissingRouteException
Когда URL не соответствует ни одному маршруту.

parseRequest() public 

parseRequest(Psr\Http\Message\ServerRequestInterface $request): array

Принимает ServerRequestInterface, итерирует маршруты, пока не сможет разобрать маршрут.

Параметры

Psr\Http\Message\ServerRequestInterface $request

Запрос для получения данных маршрута.

Возвращает

array

Исключения

Cake\Routing\Exception\MissingRouteException
Когда URL не соответствует ни одному маршруту.

registerMiddleware() public 

registerMiddleware(string $name, stringClosurePsr\Http\Server\MiddlewareInterface $middleware): $this

Зарегистрировать обработчик с RouteCollection.

После регистрации обработчик может быть применён к текущему маршрутизируемому пространству или любым дочерним пространствам, которые используют ту же RouteCollection.

Параметры

string $name

Имя обработчика. Используется при применении обработчика к пространству.

stringClosurePsr\Http\Server\MiddlewareInterface $middleware

Регистрируемый обработчик.

Возвращает

$this

Исключения

RuntimeException

routes() public 

routes(): Cake\Routing\Route\Route[]

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

Возвращает

Cake\Routing\Route\Route[]

setExtensions() public 

setExtensions(string[] $extensions, bool $merge = true): $this

Установить обработчики расширений, которые может обрабатывать коллекция маршрутов.

Параметры

string[] $extensions

Список расширений для установки.

bool $merge optional

Объединить или перезаписать существующие расширения. По умолчанию true.

Возвращает

$this

Подробное описание свойств

$_extensions protected

Расширения маршрутов

Тип

string[]

$_middleware protected

Словарь имён обработчиков и связанных с ними объектов.

Тип

array

$_middlewareGroups protected

Словарь имён групп обработчиков и связанных с ними имён обработчиков.

Тип

array

$_named protected

Хэш-карта именованных маршрутов в этой коллекции.

Тип

Cake\Routing\Route\Route[]

$_paths protected

Маршруты, индексированные по префиксам путей.

Тип

array<string, arrayCake\Routing\Route\Route>>

$_routeTable protected

Маршруты, подключённые к этой коллекции.

Тип

array

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Routing.RouteCollection.html

Spec-Zone.ru

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