类 FlashMessage
FlashMessage 类提供了一种将闪存变量写入会话的方法，以便通过 FlashHelper 在视图中呈现。
命名空间： Cake\Http
属性摘要
-
$_config protected
array<string, mixed>运行时配置
-
$_configInitialized protected
bool配置属性是否已使用默认值配置
-
$_defaultConfig protected
array<string, mixed>默认配置
-
$session protected
Cake\Http\Session
方法摘要
-
__construct() public
构造函数
-
_configDelete() protected
删除单个配置键。
-
_configRead() protected
读取配置键。
-
_configWrite() protected
写入配置键。
-
configShallow() public
将提供的配置与现有配置合并。与
config()对嵌套键进行递归合并不同，此方法进行简单的合并。 -
consume() public
获取给定键的消息并从会话中移除。
-
error() public
设置成功消息。
-
getConfig() public
返回配置。
-
getConfigOrFail() public
返回此特定键的配置。
-
info() public
设置信息消息。
-
set() public
存储可以在视图中输出的闪存消息。
-
setConfig() public
设置配置。
-
setExceptionMessage() public
将异常的消息设置为闪存消息。
-
success() public
设置成功消息。
-
warning() public
设置警告消息。
方法详细说明
__construct() ¶ public
__construct(Cake\Http\Session $session, array<string, mixed> $config = [])构造函数
参数
-
Cake\Http\Session$session 会话实例。
-
array<string, mixed>$config optional 配置数组。
另请参阅
FlashMessage::set() 有关有效配置键的列表。
_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 optional True 表示递归合并，'shallow' 表示简单合并，false 表示覆盖，默认为 false。
返回值
void抛出
Cake\Core\Exception\CakeException如果尝试覆盖现有的配置
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 optional 要设置的值。
返回值
$thisconsume() ¶ public
consume(string $key): array|null获取给定键的消息并从会话中移除。
参数
-
string$key 获取消息的键。
返回值
array|nullerror() ¶ public
error(string $message, array<string, mixed> $options = []): void设置成功消息。
'element' 选项将设置为 'error'。
参数
-
string$message 要闪存的消息。
-
array<string, mixed>$options optional 选项数组。
返回值
void另请参阅
FlashMessage::set() 有关有效选项的列表
getConfig() ¶ 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 optional 要获取的键，或用于整个配置的 null。
-
mixed$default optional 键不存在时的返回值。
返回值
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixed返回此特定键的配置。
此键的配置值必须存在，永远不能为 null。
参数
-
string$key 要获取的键。
返回值
mixed抛出
InvalidArgumentExceptioninfo() ¶ public
info(string $message, array<string, mixed> $options = []): void设置信息消息。
'element' 选项将设置为 'info'。
参数
-
string$message 要闪存的消息。
-
array<string, mixed>$options optional 选项数组。
返回值
void另请参阅
FlashMessage::set() 有关有效选项的列表
set() ¶ public
set(string $message, array<string, mixed> $options = []): void存储可以在视图中输出的闪存消息。
如果连续调用此方法，消息将堆叠（如果它们使用相同的闪存键设置）。
选项
key要在会话的 Flash 键下设置的键。element用于呈现闪存消息的元素。您可以使用'SomePlugin.name'样式的值来获取插件中的闪存元素。plugin要从中使用元素的插件名称。params要使元素可用的变量数组。clear一个布尔值，表示当前堆栈是否应该被清除以开始一个新的堆栈。escape设置为 false 以允许模板打印 HTML 内容。
参数
-
string$message 要闪存的消息。
-
array<string, mixed>$options optional 选项数组
返回值
void另请参阅
FlashMessage::$_defaultConfig 有关选项的默认值的说明。
setConfig() ¶ 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 optional 要设置的值。
-
bool$merge optional 是否递归合并或覆盖现有配置，默认为 true。
返回值
$this抛出
Cake\Core\Exception\CakeException当尝试设置无效键时。
setExceptionMessage() ¶ public
setExceptionMessage(Throwable $exception, array<string, mixed> $options = []): void将异常的消息设置为闪存消息。
如果未设置，以下选项将默认设置
'element' => 'error',
`params' => ['code' => $exception->getCode()]参数
-
Throwable$exception 异常实例。
-
array<string, mixed>$options optional 选项数组。
返回值
void另请参阅
FlashMessage::set() 有关有效选项的列表
success() ¶ public
success(string $message, array<string, mixed> $options = []): void设置成功消息。
'element' 选项将设置为 'success'。
参数
-
string$message 要闪存的消息。
-
array<string, mixed>$options optional 选项数组。
返回值
void另请参阅
FlashMessage::set() 有关有效选项的列表
warning() ¶ public
warning(string $message, array<string, mixed> $options = []): void设置警告消息。
'element' 选项将设置为 'warning'。
参数
-
string$message 要闪存的消息。
-
array<string, mixed>$options optional 选项数组。
返回值
void另请参阅
FlashMessage::set() 有关有效选项的列表