krubio/perfect-flash-bs-5

符合SOLID规范的基于会话的Flash消息 - Bootstrap 5

v0.1.0 2023-10-10 01:52 UTC

This package is auto-updated.

Last update: 2024-09-10 03:48:52 UTC


README

codecov

Scrutinizer Code Quality Code Coverage Build Status Code Intelligence Status

Coverage Maintainability Rating Code Smells Technical Debt Quality Gate Status Reliability Rating

Duplicated Lines (%) Vulnerabilities Bugs Security Rating

Bootstrap5FlashMessage

描述

Bootstrap5FlashMessage 是一个PHP类,它以简单有效的方式在Web应用程序中显示Flash消息。它使用Bootstrap 5进行样式设置,并允许使用可选图标和可关闭的警报。

要求

  • PHP 8.0或更高版本
  • Bootstrap 5.3或更高版本

安装

Bootstrap5FlashMessage 类包含到您的项目中。

使用

初始化

首先,您需要在构造函数中注入一个实现 SessionInterface 的会话对象和一个消息数组。

use PerfectApp\Session\SessionInterface;
use PerfectApp\Bootstrap5FlashMessage;

$session = new Session();  // This should implement SessionInterface
$messages = [
    'success' => [
        'insert' => 'Record Inserted'
    ],
    'danger' => [
        'failed_login' => 'Invalid Login'
    ]
];

$flash = new Bootstrap5FlashMessage($session, $messages);

添加消息

要添加Flash消息,请使用 addMessage 方法。

$flash->addMessage('success', 'insert');

您还可以添加可选的图标并使警报可关闭。

$flash->addMessage('danger', 'failed_login', 'bi-x-circle', true);

显示消息

要显示所有Flash消息,请使用 displayMessages 方法。

$flash->displayMessages();

这将输出Bootstrap 5样式的警报。

测试

运行以下命令以执行单元测试并确保100%代码覆盖率

php vendor/bin/codecept run --coverage --coverage-html  --coverage-xml

许可证

本项目使用MIT许可证。