Класс MiddlewareQueue

Предоставляет методы для создания и управления «очередью» вызываемых элементов middleware. Эта очередь используется для обработки запроса и ответа через \Cake\Http\Runner.

Cake\Http\MiddlewareQueue реализует Countable

Пространство имён: Cake\Http
Расположение: Http/MiddlewareQueue.php

Резюме свойств

$callables protected

callable[]
Очередь вызываемых элементов middleware.
$queue protected

array
Очередь элементов middleware.

Резюме методов

__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, если индекс не определён.

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

$callablessource

protected callable[]

Очередь вызываемых элементов middleware.

[]

$queuesource

protected массив

Очередь элементов middleware.

[]

© 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.7/class-Cake.Http.MiddlewareQueue.html