Spec-Zone.ru › CakePHP 3.6

Класс 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.6/class-Cake.Http.MiddlewareQueue.html

Spec-Zone.ru

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