README

一个用于向 Serato 用户资料应用程序发送用户资料属性和事件的 PHP 库。

通过 composer.json 添加到项目

要将此库包含到 PHP 项目中，请将以下行添加到项目 composer.json 文件的 require 部分

{
	"require": {
		"serato/sup-sdk-php": "dev-master"
	}
}

有关所有可用版本的列表，请参阅 Packagist

此库需要 PHP 7.1 或更高版本。

使用 PHP_CodeSniffer 验证您的代码是否符合编码标准

$ ./vendor/bin/phpcs

使用 PHPStan 进行静态代码分析

$ vendor/bin/phpstan analyse

PHPUnit 的配置定义在 phpunit.xml 中。

运行测试

$ php vendor/bin/phpunit

可以通过 phpinit 运行带有 AWS 服务的集成测试

$ php vendor/bin/phpunit --group aws-integration

可以使用 Sami PHP API 文档生成器生成 PHP API 文档。

生成文档

$ vendor/bin/sami.php update phpdoc.php

文档生成在 docs\php 目录中。

Sami 的配置包含在 phpdoc.php 中。

如果您已安装 phpdbg，则可以使用 phpunit 生成代码覆盖率报告

$ phpdbg -qrr ./vendor/bin/phpunit --coverage-html reports/coverage

报告生成在 reports 目录中。