kaikan/flashmessage

类的作用是向用户输出反馈。

dev-master 2014-12-14 20:33 UTC

This package is not auto-updated.

Last update: 2024-09-24 16:03:14 UTC


README

Scrutinizer Code Quality Code Coverage Build Status

ANAXMVC 的 Flashmessage 模块

FlashMessage 是为 anaxMVC 构建的辅助工具,用于显示闪存消息。此模块需要您已安装 anaxMVC,因此请在安装此模块之前确保已安装。

许可证

本软件是免费软件,并带有 MIT 许可证。

安装

使用 composer 和 packagist 安装: "kakan/flashmessage": "dev-master"。请注意,您可能需要自己将样式表 Flashmessage.css 放入正确的文件夹。正确的文件夹如下:

Flashmessage.css = anaxMVC/webroot/css/

CFlashMessage.php = anaxMVC/src/CFlashMessage/

如何开始使用

要使 Flashmessage 工作的第一件事是在您的 front-controller 中启动一个会话。在启动会话后,您需要将以下代码添加到您选择的 front-controller 中。

$di->set('flash', function() { $flash = new \Anax\CFlashMessage\CFlashMessage(); return $flash; });

这是为了初始化我们的模块,在模块初始化后,我们就可以使用了。现在,您需要添加以下代码来显示您想要显示的消息。

$app->theme->addStylesheet('css/FlashMessage.css');

$app->flash->newMessage('您已成功安装 flashMessage 模块', 'Success');

$app->views->add('me/page', array('content' => $app->flash->showMessage()));

现在,您的模块应该已正常工作,您可以看到任何想要显示的消息。如果模块不起作用,请返回安装指南并确保您已正确执行每一步。

函数

函数对您很重要,因为它们决定了您的消息如何显示。

如果我们看看您可以使用哪些函数,它们如下所示:

newMessage($message, $type); 将消息替换为您想要 flashMessage 输出的文本。类型是 div 类的名称。此模块包含 4 个预安装的类型(divs),错误、通知、成功、警告。您可以使用这些预安装的类型或使用随模块附带的 CSS 文件自定义类型。

showMessage(); 此函数显示当前会话中存储的所有消息。

deleteMessage(); 此函数删除当前会话中存储的所有消息。