Класс MiddlewareQueue
Предоставляет методы для создания и управления «очередью» вызываемых сред. Эта очередь используется для обработки запроса и ответа через \Cake\Http\Runner.
- Cake\Http\MiddlewareQueue реализует Countable
Краткое описание свойств
-
$callablesprotectedОчередь вызываемых сред.callable[] -
$queueprotectedОчередь сред.array
Краткое описание методов
- __construct() publicКонструктор
- add() publicДобавить вызываемый элемент среды в конец очереди.
- count() publicПолучить количество подключенных слоев среды.
- get() publicПолучить элемент среды по предоставленному индексу.
- insertAfter() publicВставить объект среды после первого совпавшего класса.
- insertAt() publicВставить вызываемый элемент среды в определенный индекс.
- insertBefore() publicВставить объект среды перед первым совпавшим классом.
- prepend() publicДобавить элемент среды в начало очереди.
- push() publicПсевдоним для MiddlewareQueue::add().
- resolve() protectedРазрешить имя среды для вызова.
Подробное описание методов
__construct()source public
__construct( array $middleware = [] )
Конструктор
Параметры
- массив
$middlewareнеобязательный [] - Список сред для добавления.
add()source public
add( callable|string|array $middleware )
Добавить вызываемый элемент среды в конец очереди.
Параметры
- вызываемый элемент/строка/массив
$middleware - Элемент(ы) среды для добавления.
Возвращаемое значение
$this
count()source public
count( )
Получить количество подключенных слоев среды.
Реализация интерфейса Countable.
Возвращаемое значение
целое числоРеализация
Countable::count() get()source public
get( integer $index )
Получить элемент среды по предоставленному индексу.
Параметры
- целое число
$index - Индекс для извлечения.
Возвращаемое значение
вызываемый элемент/nullВызываемый элемент среды или null, если индекс не определен.
insertAfter()source public
insertAfter( string $class , callable|string $middleware )
Вставить объект среды после первого совпавшего класса.
Находит индекс первого элемента среды, который соответствует предоставленному классу, и вставляет предоставленный вызываемый элемент после него. Если класс не найден, этот метод будет вести себя как add().
Параметры
- строка
$class - Имя класса, перед которым нужно вставить элемент среды.
- вызываемый элемент/строка
$middleware - Элемент среды для вставки.
Возвращаемое значение
$this
insertAt()source public
insertAt( integer $index , callable|string $middleware )
Вставить вызываемый элемент среды в определенный индекс.
Если индекс уже существует, новый вызываемый элемент будет вставлен, а существующий элемент будет сдвинут на один индекс больше.
Параметры
- целое число
$index - Индекс для вставки.
- вызываемый элемент/строка
$middleware - Элемент среды для вставки.
Возвращаемое значение
$this
insertBefore()source public
insertBefore( string $class , callable|string $middleware )
Вставить объект среды перед первым совпавшим классом.
Находит индекс первого элемента среды, который соответствует предоставленному классу, и вставляет предоставленный вызываемый элемент перед ним.
Параметры
- строка
$class - Имя класса, перед которым нужно вставить элемент среды.
- вызываемый элемент/строка
$middleware - Элемент среды для вставки.
Возвращаемое значение
$this
Исключения
LogicExceptionЕсли элемент среды для вставки не найден.
prepend()source public
prepend( callable|string|array $middleware )
Добавить элемент среды в начало очереди.
Параметры
- вызываемый элемент/строка/массив
$middleware - Элемент(ы) среды для добавления в начало.
Возвращаемое значение
$this
push()source public
push( callable|string|array $middleware )
Псевдоним для MiddlewareQueue::add().
Параметры
- вызываемый элемент/строка/массив
$middleware - Элемент(ы) среды для добавления.
Возвращаемое значение
$this
См. также
MiddlewareQueue::add()resolve()source protected
resolve( integer $index )
Разрешить имя среды для вызова.
Параметры
- целое число
$index - Индекс для извлечения.
Возвращаемое значение
вызываемый элемент/nullВызываемый элемент среды или null, если индекс не определен.
Подробное описание свойств
© 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/3.6/class-Cake.Http.MiddlewareQueue.html