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