Spec-Zone.ru › CakePHP 3.3

Класс MiddlewareQueue

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

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

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

  • $callables protected
    array
    Очередь вызываемых сред.
  • $queue protected
    array
    Очередь сред.

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

  • add() public
    Добавляет вызываемую среду в конец очереди.
  • count() public
    Получить количество подключенных слоев сред.
  • get() public
    Получить среду по заданному индексу.
  • insertAfter() public
    Вставить объект среды после первого совпавшего класса.
  • insertAt() public
    Вставить вызываемую среду в определенный индекс.
  • insertBefore() public
    Вставить объект среды перед первым совпавшим классом.
  • prepend() public
    Добавить среду в начало очереди.
  • push() public
    Псевдоним для MiddlewareQueue::add().
  • resolve() protected
    Разрешить имя среды до вызываемого объекта.

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

add()source public

add( callable|string|array $middleware )

Добавляет вызываемую среду в конец очереди.

Параметры

callable|string|array $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
Имя класса, перед которым нужно вставить среду.
callable|строка $middleware
Вставляемая среда.

Возвращает


$this

insertAt()source public

insertAt( integer $index , callable|string $middleware )

Вставить вызываемую среду в определенный индекс.

Если индекс уже существует, новый вызываемый объект будет вставлен, а существующий элемент будет сдвинут на один индекс больше.

Параметры

целое число $index
Индекс для вставки.
callable|строка $middleware
Вставляемая среда.

Возвращает


$this

insertBefore()source public

insertBefore( string $class , callable|string $middleware )

Вставить объект среды перед первым совпавшим классом.

Находит индекс первой среды, соответствующей указанному классу, и вставляет предоставленный вызываемый объект перед ним.

Параметры

строка $class
Имя класса, перед которым нужно вставить среду.
callable|строка $middleware
Вставляемая среда.

Возвращает


$this

Выбрасывает

LogicException
Если среда для вставки перед ней не найдена.

prepend()source public

prepend( callable|string|array $middleware )

Добавить среду в начало очереди.

Параметры

callable|string|array $middleware
Вставляемая(ые) среда(ы).

Возвращает


$this

push()source public

push( callable|string|array $middleware )

Псевдоним для MiddlewareQueue::add().

Параметры

callable|string|array $middleware
Добавляемая среда(ы).

Возвращает


$this

См. также

MiddlewareQueue::add()

resolve()source protected

resolve( integer $index )

Разрешить имя среды до вызываемого объекта.

Параметры

целое число $index
Индекс для получения.

Возвращает

вызываемый объект|null

Вызываемый объект среды или null, если индекс не определен.


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

$callablessource

protected массив

Очередь вызываемых сред.

[]

$queuesource

protected массив

Очередь сред.

[]

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

Spec-Zone.ru

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