Spec-Zone.ru › CakePHP 4.3

Класс MiddlewareQueue

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

Пространство имён: Cake\Http

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

  • $position protected
    int

    Внутренняя позиция для итератора.

  • $queue protected
    array<int, mixed>

    Очередь middleware.

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

  • __construct()public

    Конструктор

  • add()public

    Добавляет мидлварь в конец очереди.

  • count()public

    Возвращает количество подключенных слоев мидлваря.

  • current()public

    Возвращает текущий мидлварь.

  • insertAfter()public

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

  • insertAt()public

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

  • insertBefore()public

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

  • key()public

    Возвращает ключ мидлваря.

  • next()public

    Перемещает текущую позицию к следующему мидлвару.

  • prepend()public

    Добавляет мидлварь в начало очереди.

  • push()public

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

  • resolve()protected

    Преобразует имя мидлваря в экземпляр мидлваря, совместимый с PSR 15.

  • rewind()public

    Перемотка к первому элементу очереди.

  • seek()public

    Переход к заданной позиции в очереди.

  • valid()public

    Проверяет, является ли текущая позиция допустимой.

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

public __construct()

__construct(array $middleware = [])

Конструктор

Параметры

array

Список мидлварей для добавления.

public add()

add(Psr\Http\Server\MiddlewareInterfaceClosure|array|string $middleware): $this

Добавляет мидлварь в конец очереди.

Параметры

Psr\Http\Server\MiddlewareInterfaceClosure|array|string

Мидлварь(и) для добавления.

Возвращает

$this

public count()

count(): int

Возвращает количество подключенных слоев мидлваря.

Реализует интерфейс Countable.

Возвращает

int

public current()

current(): Psr\Http\Server\MiddlewareInterface

Возвращает текущий мидлварь.

Возвращает

Psr\Http\Server\MiddlewareInterface

См. также

\Iterator::current()

public insertAfter()

insertAfter(string $class, Psr\Http\Server\MiddlewareInterfaceClosure|string $middleware): $this

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

Находит индекс первого мидлваря, соответствующего предоставленному классу, и вставляет поставленный мидлварь после него. Если класс не найден, этот метод будет вести себя как add().

Параметры

string

Имя класса, перед которым нужно вставить мидлварь.

Psr\Http\Server\MiddlewareInterfaceClosure|string

Мидлварь для вставки.

Возвращает

$this

public insertAt()

insertAt(int $index, Psr\Http\Server\MiddlewareInterfaceClosure|string $middleware): $this

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

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

Параметры

int

Индекс для вставки.

Psr\Http\Server\MiddlewareInterfaceClosure|string

Мидлварь для вставки.

Возвращает

$this

public insertBefore()

insertBefore(string $class, Psr\Http\Server\MiddlewareInterfaceClosure|string $middleware): $this

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

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

Параметры

string

Имя класса, перед которым нужно вставить мидлварь.

Psr\Http\Server\MiddlewareInterfaceClosure|string

Мидлварь для вставки.

Возвращает

$this

Исключения

LogicException

public key()

key(): int

Возвращает ключ мидлваря.

Возвращает

int

См. также

\Iterator::key()

public next()

next(): void

Перемещает текущую позицию к следующему мидлвару.

Возвращает

void

См. также

\Iterator::next()

public prepend()

prepend(Psr\Http\Server\MiddlewareInterfaceClosure|array|string $middleware): $this

Добавляет мидлварь в начало очереди.

Параметры

Psr\Http\Server\MiddlewareInterfaceClosure|array|string

Мидлварь(и) для добавления в начало.

Возвращает

$this

public push()

push(Psr\Http\Server\MiddlewareInterfaceClosure|array|string $middleware): $this

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

Параметры

Psr\Http\Server\MiddlewareInterfaceClosure|array|string

Мидлварь(и) для добавления.

Возвращает

$this

См. также

MiddlewareQueue::add()

protected resolve()

resolve(Psr\Http\Server\MiddlewareInterfaceClosure|string $middleware): Psr\Http\Server\MiddlewareInterface

Преобразует имя мидлваря в экземпляр мидлваря, совместимый с PSR 15.

Параметры

Psr\Http\Server\MiddlewareInterfaceClosure|string

Мидлварь для преобразования.

Возвращает

Psr\Http\Server\MiddlewareInterface

Исключения

RuntimeException

public rewind()

rewind(): void

Перемотка к первому элементу очереди.

Возвращает

void

См. также

\Iterator::rewind()

public seek()

seek(int $position): void

Переход к заданной позиции в очереди.

Параметры

int

Позиция для перехода.

Возвращает

void

См. также

\SeekableIterator::seek()

public valid()

valid(): bool

Проверяет, является ли текущая позиция допустимой.

Возвращает

bool

См. также

\Iterator::valid()

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

$positionprotected

Внутренняя позиция для итератора.

Тип

int

$queueprotected

Очередь мидлварей.

Тип

array<int, mixed>

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

Spec-Zone.ru

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