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