Spec-Zone.ru › CakePHP 3.8

Класс MiddlewareQueue

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

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

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

  • $callables protected
    callable[]
    Очередь вызываемых посредников.
  • $queue protected
    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, если индекс не определён.


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

$callablessource

protected callable[]

Очередь вызываемых посредников.

[]

$queuesource

protected массив

Очередь посредников.

[]

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

Spec-Zone.ru

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