README

管理员通知服务。

目录

• 安装
  • 依赖
• 服务提供商
  • 参数
  • 服务
• 配置
• 使用
• 开发
  • API 文档
  • 开发依赖
  • 编码风格
• 致谢
• 许可

安装

首选（也是唯一支持）的方法是使用 Composer

$ composer require locomotivemtl/charcoal-contrib-notification

依赖

要求

• PHP 5.6+: 推荐使用 PHP 7。
• locomotivemtl/charcoal-admin >=0.15.7

PSR

• PSR-7: HTTP 消息的通用接口。由 Slim 实现。
• PSR-11: 依赖容器的通用接口。由 Pimple 实现。

配置

在你的项目的配置文件中，需要通知模块

{
    "modules": {
        "charcoal/notification/notification": {}
    }
}

使用

使用 object/collection?obj_type=charcoal/notification/notification-target 定义可通知的对象

通过 object/collection?obj_type=charcoal/notification/notification 设置你的通知

设置cron作业如下

// Daily (8 stands for 8am)
0 8 * * * cd /[project]/web && /usr/local/bin/php /[project]/web/vendor/bin/charcoal admin/notification/daily

// Hourly
0 * * * * cd /[project]/web && /usr/local/bin/php /[project]/web/vendor/bin/charcoal admin/notification/hourly

// Every minute
* * * * * cd /[project]/web && /usr/local/bin/php /[project]/web/vendor/bin/charcoal admin/notification/minute

// Monthly (8 stands for 8am)
0 8 1 * * cd /[project]/web && /usr/local/bin/php /[project]/web/vendor/bin/charcoal admin/notification/montly

// Weekly (8 stands for 8am, 1 stands for monday)
0 8 * * 1 cd /[project]/web && /usr/local/bin/php /[project]/web/vendor/bin/charcoal admin/notification/weekly

开发

要安装开发环境

$ composer install

要运行脚本（phplint、phpcs 和 phpunit）

$ composer test

API 文档

• 自动生成的 phpDocumentor API 文档在以下位置可用
  https://locomotivemtl.github.io/charcoal-contrib-notification/docs/master/
• 自动生成的 apigen API 文档在以下位置可用
  https://codedoc.pub/locomotivemtl/charcoal-contrib-notification/master/

开发依赖

• [php-coveralls/php-coveralls][phpcov]
• [phpunit/phpunit][phpunit]
• [squizlabs/php_codesniffer][phpcs]

编码风格

charcoal-contrib-notification 模块遵循 Charcoal 编码风格

• PSR-1
• PSR-2
• PSR-4，因此自动加载由 Composer 提供。
• phpDocumentor 注释。
• phpcs.xml.dist 和 .editorconfig 用于编码标准。

可以使用 composer phpcs 执行编码风格验证/强制执行。还有一个自动修复器，使用 composer phpcbf。

致谢

• Locomotive

许可

Charcoal 根据 MIT 许可证授权。有关详细信息，请参阅 LICENSE。