knifecake/outmess

此包已被弃用,不再维护。未建议替换包。

轻松跟踪结果消息。

1.1 2014-09-28 20:40 UTC

This package is not auto-updated.

Last update: 2020-08-16 20:12:52 UTC


README

此包允许您根据进程的结果添加消息,例如更新用户或删除菜单项。然后您可以一次性检索所有这些消息,并根据您设置的配置(例如,您正在使用的UI框架)将它们格式化为HTML。

安装

将以下内容添加到您的 composer.json 文件中

"require": {
  ...
  "knifecake/outmess": "1.*"
},

将以下内容添加到您的 Service Provider 数组中的 app/config/app.php

  ...
  'Knifecake\Outmess\OutmessServiceProvider',

并在 aliases 数组下添加以下内容

  ...
  'Outmess' => 'Knifecake\Outmess\Facades\Outmess',
  ...

设置新的样式

样式用于在调用 Outmess::render() 时渲染您的消息。所有样式都位于配置文件中的 styles 数组内。每个样式都包含一个或多个与您添加消息时使用的方法名称对应的消息类型。因此,要设置错误消息,您可以调用 Outmess::error($message) 并在您的样式中使用 message 键定义该消息类型。以下是一个样式定义的示例

'styles' => array(
  'style-name' => array(
    'message-type-1' => '<p>Message format string 1, always containing :message</p>',
    ...
    'message-type-n' => '<p>Message format string n, always containing :message</p>',
  ),
),

选择要使用的样式

要选择您想要使用的样式,请将 'style' 配置值更改为您希望使用的样式名称,只要它在样式数组中定义即可。您也可以通过调用 Outmess::style('new-style') 在运行时更改您正在使用的样式。请注意,您设置的样式将影响您已添加的所有消息(如果有)。

输出消息

要使用您选择的样式输出您的消息,请调用 Outmess::render()。此方法输出一个HTML字符串,因此可以在视图上调用它,例如在页面顶部。如果您没有添加任何消息,此方法不会输出任何内容,因此如果您在调用之前没有检查,请不要担心。

贡献和报告错误

想要新功能?有什么问题?有任何疑问?请访问 https://github.com/knifecake/outmess 并发起一个pull request或创建一个新的issue。