BigBlueButton API for PHP

---

The official BigBlueButton PHP API Client provides a developer-friendly wrapper to interact with the BigBlueButton API. Built for PHP 8.1+, this library simplifies integration and management of BigBlueButton servers in your PHP applications.

---

📦 Installation & Usage

You can find the full documentation, including sample usage and installation instructions, in our [Wiki].

composer require bigbluebutton/bigbluebutton-api-php

---

🐞 Issues & Feature Requests

Please use the GitHub Issues tracker to report bugs or suggest new features.

---

🧪 Code Quality & Testing

This project follows strict code quality checks before allowing commits. Here's how to contribute effectively:

1. Coding Style

# Using Composer alias
composer code-fix

# Or directly
PHP_CS_FIXER_IGNORE_ENV=1 ./vendor/bin/php-cs-fixer fix --allow-risky yes

2. Static Analysis

composer code-check
# Or
./vendor/bin/phpstan analyse

3. Running Tests

composer code-test
# Or
./vendor/bin/phpunit

To run a specific test:

composer code-test -- --filter BigBlueButtonTest::testApiVersion

To skip code coverage:

composer code-test -- --no-coverage

Coverage reports are stored in: ./var/coverage/

4. Configuration

To connect tests to your own BigBlueButton server, copy .env to .env.local and configure:

BBB_SERVER_BASE_URL=https://your-bbb-server.example.com/bigbluebutton/
BBB_SECRET=your-secret

---

✅ Pre-Commit Checks (CaptainHook)

We use CaptainHook to enforce code quality:

• ✔️ Commit message format (beams)
• ✔️ Code style (PHPCS-Fixer)
• ✔️ Static analysis (PHPStan)
• ✔️ PHPUnit tests

You can manually run all pre-commit checks to avoid errors:

composer code-fix
composer code-check
composer code-test

Do not skip checks using --no-verify unless absolutely necessary.

CaptainHook should be installed automatically after the first composer install. If not:

vendor/bin/captainhook install

---

📝 License

This project is licensed under the terms of the LGPL-3.0.