juniora / bigbluebutton-api-php
PHP的BigBlueButton API库
2.4.1
2024-05-29 16:51 UTC
Requires
- php: >=7.4
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- ext-simplexml: *
- marc-mabe/php-enum: ^v4.7.0
Requires (Dev)
- bmitch/churn-php: ^1.7.1
- fakerphp/faker: ^v1.23.1
- friendsofphp/php-cs-fixer: ^v3.48.0
- nunomaduro/phpinsights: ^v2.11.0
- phploc/phploc: ^7.0.2
- phpmetrics/phpmetrics: ^v2.8.2
- phpstan/phpstan: ^1.10
- phpunit/php-code-coverage: 9.2.30
- phpunit/phpunit: ^9.6.16
- squizlabs/php_codesniffer: ^3.8.1
- tracy/tracy: 2.9
- vlucas/phpdotenv: ^5.6
- wapmorgan/php-deprecation-detector: ^2.0.33
This package is not auto-updated.
Last update: 2024-09-19 16:42:54 UTC
README
官方且易于使用的PHP BigBlueButton API,使开发者更容易使用 BigBlueButton API 进行 PHP 7.4+ 开发。
安装和使用
在 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
),您现在将使用自己的服务器进行测试。