类 QueueTransport
属性摘要
-
$_config protected
array<string, mixed>运行时配置
-
$_configInitialized protected
bool配置属性是否已使用默认值配置
-
$_defaultConfig protected
array<string, mixed>此类的默认配置
方法摘要
-
__construct() public
构造函数
-
_configDelete() protected
删除单个配置键。
-
_configRead() protected
读取配置键。
-
_configWrite() protected
写入配置键。
-
checkRecipient() protected
检查是否至少设置了一个目标头。
-
configShallow() public
将提供的配置与现有配置合并。与 `config()` 对嵌套键执行递归合并不同，此方法执行简单的合并。
-
enqueueJob() protected
将作业添加到队列
-
getConfig() public
返回配置。
-
getConfigOrFail() public
返回此特定键的配置。
-
prepareData() protected
准备作业数据
-
send() public
发送邮件
-
setConfig() public
设置配置。
方法详细
__construct() ¶ public
__construct(array<string, mixed> $config = [])构造函数
参数
-
array<string, mixed>$config 可选 配置选项。
_configDelete() ¶ protected
_configDelete(string $key): void删除单个配置键。
参数
-
string$key 要删除的键。
返回值
void抛出
Cake\Core\Exception\CakeException如果尝试覆盖现有配置
_configRead() ¶ protected
_configRead(string|null $key): mixed读取配置键。
参数
-
string|null$key 要读取的键。
返回值
mixed_configWrite() ¶ protected
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void写入配置键。
参数
-
array<string, mixed>|string$key 要写入的键。
-
mixed$value 要写入的值。
-
string|bool$merge 可选 是否递归合并（True）、简单合并（'shallow'）或覆盖（False），默认为 False。
返回值
void抛出
Cake\Core\Exception\CakeException如果尝试覆盖现有配置
checkRecipient() ¶ protected
checkRecipient(Cake\Mailer\Message $message): void检查是否至少设置了一个目标头。
参数
-
Cake\Mailer\Message$message 消息实例。
返回值
void抛出
Cake\Core\Exception\CakeException如果 to、cc 或 bcc 中至少有一个未指定。
configShallow() ¶ public
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this将提供的配置与现有配置合并。与 `config()` 对嵌套键执行递归合并不同，此方法执行简单的合并。
设置特定值
$this->configShallow('key', $value);设置嵌套值
$this->configShallow('some.nested.key', $value);同时更新多个配置设置
$this->configShallow(['one' => 'value', 'another' => 'value']);参数
-
array<string, mixed>|string$key 要设置的键，或完整的配置数组。
-
mixed|null$value 可选 要设置的值。
返回值
$thisenqueueJob() ¶ protected
enqueueJob(array $data, array $options): void将作业添加到队列
参数
-
array$data 要发送到作业的数据
-
array$options 作业选项
返回值
voidgetConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixed返回配置。
用法
读取整个配置
$this->getConfig();读取特定值
$this->getConfig('key');读取嵌套值
$this->getConfig('some.nested.key');使用默认值读取
$this->getConfig('some-key', 'default-value');参数
-
string|null$key 可选 要获取的键，或获取整个配置时为 null。
-
mixed$default 可选 键不存在时的返回值。
返回值
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixed返回此特定键的配置。
此键的配置值必须存在，不能为 null。
参数
-
string$key 要获取的键。
返回值
mixed抛出
InvalidArgumentExceptionprepareData() ¶ protected
prepareData(Cake\Mailer\Message $message): array准备作业数据
参数
-
Cake\Mailer\Message$message 电子邮件消息
返回值
arraysend() ¶ public
send(Cake\Mailer\Message $message): array发送邮件
参数
-
Cake\Mailer\Message$message
返回值
arraysetConfig() ¶ public
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this设置配置。
用法
设置特定值
$this->setConfig('key', $value);设置嵌套值
$this->setConfig('some.nested.key', $value);同时更新多个配置设置
$this->setConfig(['one' => 'value', 'another' => 'value']);参数
-
array<string, mixed>|string$key 要设置的键，或完整的配置数组。
-
mixed|null$value 可选 要设置的值。
-
bool$merge 可选 是否递归合并或覆盖现有配置，默认为 True。
返回值
$this抛出
Cake\Core\Exception\CakeException尝试设置无效键时。