类 MiddlewareQueue

提供用于创建和操作中间件“队列”的方法。此队列用于通过 \Cake\Http\Runner 处理请求并生成响应。

命名空间: Cake\Http

属性摘要

$container protected

Cake\Core\ContainerInterface|null
$position protected

int

迭代器的内部位置。
$queue protected

array<int, mixed>

中间件的队列。

方法摘要

__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

检查当前位置是否有效。

方法详情

__construct() ¶ public

__construct(array $middleware = [], Cake\Core\ContainerInterface $container = null)

构造函数

参数

array $middleware 可选: 要追加的中间件列表。
Cake\Core\ContainerInterface $container 可选: 容器实例。

add() ¶ public

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

将中间件追加到队列末尾。

参数

Psr\Http\Server\MiddlewareInterfaceClosure|array|string $middleware: 要追加的中间件。

返回值

$this

count() ¶ public

count(): int

获取连接的中间件层的数量。

实现 Countable 接口。

返回值

int

current() ¶ public

current(): Psr\Http\Server\MiddlewareInterface

返回当前中间件。

返回值

Psr\Http\Server\MiddlewareInterface

另请参阅

\Iterator::current()

insertAfter() ¶ public

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

在第一个匹配类之后插入一个中间件对象。

查找与提供的类匹配的第一个中间件的索引，并在其后插入提供的中间件。如果未找到该类，此方法将像 add() 一样执行。

参数

string $class: 要插入中间件之前的类名。
Psr\Http\Server\MiddlewareInterfaceClosure|string $middleware: 要插入的中间件。

返回值

$this

insertAt() ¶ public

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

在特定索引处插入中间件。

如果索引已存在，则将插入新的中间件，并且现有元素将向后移动一个索引。

参数

int $index: 要插入的索引。
Psr\Http\Server\MiddlewareInterfaceClosure|string $middleware: 要插入的中间件。

返回值

$this

insertBefore() ¶ public

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

在第一个匹配类之前插入一个中间件。

查找与提供的类匹配的第一个中间件的索引，并在其前插入提供的中间件。

参数

string $class: 要插入中间件之前的类名。
Psr\Http\Server\MiddlewareInterfaceClosure|string $middleware: 要插入的中间件。

返回值

$this

抛出

LogicException
如果要插入的中间件未找到。

key() ¶ public

key(): int

返回中间件的键。

返回值

int

另请参阅

\Iterator::key()

next() ¶ public

next(): void

将当前位置移动到下一个中间件。

返回值

void

另请参阅

\Iterator::next()

prepend() ¶ public

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

将中间件预置到队列开头。

参数

Psr\Http\Server\MiddlewareInterfaceClosure|array|string $middleware: 要预置的中间件。

返回值

$this

push() ¶ public

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

MiddlewareQueue::add() 的别名。

参数

Psr\Http\Server\MiddlewareInterfaceClosure|array|string $middleware: 要追加的中间件。

返回值

$this

另请参阅

MiddlewareQueue::add()

resolve() ¶ protected

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

将中间件名称解析为符合 PSR 15 的中间件实例。

参数

Psr\Http\Server\MiddlewareInterfaceClosure|string $middleware: 要解析的中间件。

返回值

Psr\Http\Server\MiddlewareInterface

抛出

InvalidArgumentException
如果未找到中间件。

rewind() ¶ public

rewind(): void

倒回到队列的第一个元素。

返回值

void

另请参阅

\Iterator::rewind()

seek() ¶ public

seek(int $position): void

在队列中查找给定的位置。

参数

int $position: 要查找的位置。

返回值

void

另请参阅

\SeekableIterator::seek()

valid() ¶ public

valid(): bool

检查当前位置是否有效。

返回值

bool

另请参阅

\Iterator::valid()

属性详情

`$container` ¶ protected

类型

Cake\Core\ContainerInterface|null

`$position` ¶ protected

迭代器的内部位置。

类型

int

`$queue` ¶ protected

中间件的队列。

类型

array<int, mixed>

命名空间

类 MiddlewareQueue

属性摘要

方法摘要

__construct() public

add() public

count() public

current() public

insertAfter() public

insertAt() public

insertBefore() public

key() public

next() public

prepend() public

push() public

resolve() protected

rewind() public

seek() public

valid() public

方法详情

__construct() ¶ public

参数

add() ¶ public

参数

返回值

count() ¶ public

返回值

current() ¶ public

返回值

另请参阅

insertAfter() ¶ public

参数

返回值

insertAt() ¶ public

参数

返回值

insertBefore() ¶ public

参数

返回值

抛出

key() ¶ public

返回值

另请参阅

next() ¶ public

返回值

另请参阅

prepend() ¶ public

参数

返回值

push() ¶ public

参数

返回值

另请参阅

resolve() ¶ protected

参数

返回值

抛出

rewind() ¶ public

返回值

另请参阅

seek() ¶ public

参数

返回值

另请参阅

valid() ¶ public

返回值

另请参阅

属性详情

$container ¶ protected

类型

$position ¶ protected

类型

$queue ¶ protected

类型

`$container` ¶ protected

`$position` ¶ protected

`$queue` ¶ protected