README

BigBlueButton PHP API 的官方和易用版本，使得开发者能够轻松使用针对 PHP 7.4+ 的 BigBlueButton API。

安装和使用

wiki 包含了与 PHP 库相关的所有文档。我们还编写了一些示例，以展示完整的安装和使用示例。

提交错误和功能请求

错误和功能请求在 GitHub 上跟踪。

贡献指南

代码质量 1：风格

确保通过运行 PHPCS-Fixer 应用代码风格配置。

# using an alias
$ composer cs-fix

代码质量 2：静态代码分析

通过运行以下命令使用 PHPStan 进行静态代码分析

# using an alias
$ composer code-check

# or the same w/o alias
$ ./vendor/bin/phpstan analyse

代码质量 3：测试

对于每个实现的功能，添加单元测试，并通过运行以下命令检查所有测试是否通过。

# using an alias
$ composer code-test

# or the same w/o alias
./vendor/bin/phpunit

运行单个测试

# using an alias
$ composer code-test -- --filter BigBlueButtonTest::testApiVersion

# or the same w/o alias
./vendor/bin/phpunit --filter BigBlueButtonTest::testApiVersion

测试的同时将创建代码覆盖率报告。此报告将存储在

./var/coverage/

如果在创建代码覆盖率报告时遇到问题（例如，本地环境不满足要求），可以使用以下命令跳过创建

# using an alias
$ composer code-test -- --no-coverage

备注

一些测试将连接到现有的 BBB 服务器，该服务器在 .env 文件中指定。您可以通过将此文件复制到同一文件夹并将名称更改为 .env.local 来指定自己的 BBB 服务器。将凭据 BBB_SERVER_BASE_URL 和 BBB_SECRET 交换为您的服务器值。由于此新文件（.env.local）比主文件（.env）具有优先级，您现在将使用自己的服务器进行测试。

bigbluebutton / bigbluebutton-api-php

维护者

详情