Spec-Zone.ru › CakePHP 3.5

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

Spec-Zone.ru

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