onoi/message-reporter

一个用于向注册处理程序报告和转发任意消息的接口

1.4.2 2021-01-15 14:23 UTC

This package is auto-updated.

Last update: 2024-08-29 04:09:01 UTC


README

Build Status Code Coverage Scrutinizer Code Quality Latest Stable Version Packagist download count

一个用于向注册处理程序报告和转发任意消息的接口。这是 Semantic MediaWiki 代码库的一部分,现在作为一个独立的库部署。

要求

PHP 7.3 或更高版本

安装

此库推荐的安装方法是将它作为依赖项添加到您的 composer.json

{
	"require": {
		"onoi/message-reporter": "~1.4"
	}
}

用法

消息报告器指定 MessageReporterMessageReporterAware 作为与一组支持类交互的接口

  • MessageReporterFactory
  • ObservableMessageReporter
  • NullMessageReporter
  • SpyMessageReporter
  • CallbackMessageReporter
use Onoi\MessageReporter\MessageReporterFactory;
use Onoi\MessageReporter\MessageReporterAware;
use Onoi\MessageReporter\MessageReporterAwareTrait;

class Bar implements MessageReporterAware {

	use MessageReporterAwareTrait;

	public function __construct() {
		$this->messageReporter = MessageReporterFactory::getInstance()->newNullMessageReporter();
	}

	public function doSomething() {
		$this->messageReporter->reportMessage( 'Doing ...' );
	}
}
use Onoi\MessageReporter\MessageReporterFactory;
use Onoi\MessageReporter\MessageReporter;

class Foo implements MessageReporter {

	public function reportMessage( $message ) {
		// output
	}
}

$foo = new Foo();

$messageReporterFactory = new MessageReporterFactory();

$observableMessageReporter = $messageReporterFactory->newObservableMessageReporter();
$observableMessageReporter->registerReporterCallback( array( $foo, 'reportMessage' ) );

or

// If the class implements the MessageReporter
$observableMessageReporter->registerMessageReporter( $foo );

$bar = new Bar();
$bar->setMessageReporter( $observableMessageReporter );

贡献和支持

如果您想为项目做出贡献,请订阅开发人员邮件列表,并查看 贡献指南。过去做出贡献的人员名单可以在 这里 找到。

开发

首先通过执行以下命令安装项目依赖项:

composer update

您可以通过执行以下命令运行测试:

make test

您可以通过执行以下命令运行样式检查:

make cs

要运行所有 CI 检查,请执行以下命令:

make ci

您还可以直接调用 PHPUnit 并传递参数,如下所示:

vendor/bin/phpunit --filter SomeClassNameOrFilter

发布说明

  • 1.4.2 (2021-01-15)

    • 添加了对 PHP 8 的支持
    • 将最低 PHP 版本更改为 7.3
  • 1.4.1 (2019-04-10)

    • 添加 .gitattributes
  • 1.4.0 (2019-04-08)

    • 添加 CallbackMessageReporter
    • 将最低 PHP 版本更改为 5.6.99
  • 1.3.0 (2017-11-05)

    • 添加 MessageReporterAwareTrait
  • 1.2.0 (2016-08-02)

    • 添加 MessageReporterAwareSpyMessageReporter
  • 1.1.0 (2016-04-13)

    • ObservableMessageReporter::registerReporterCallback 仅用于注册可调用处理程序
  • 1.0.0 (2015-01-24)

    • 初始发布
    • MessageReporterFactory
    • ObservableMessageReporter
    • NullMessageReporter
    • MessageReporter

许可协议

GNU 通用公共许可证 2.0 或更高版本.