https://github.com/bigbluebutton/bigbluebutton-api-php
Offical @BigBlueButton PHP API
https://github.com/bigbluebutton/bigbluebutton-api-php
bigbluebutton bigbluebutton-api php
Last synced: 9 months ago
JSON representation
Offical @BigBlueButton PHP API
- Host: GitHub
- URL: https://github.com/bigbluebutton/bigbluebutton-api-php
- Owner: bigbluebutton
- License: lgpl-3.0
- Created: 2016-01-17T19:20:31.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2025-04-05T15:10:02.000Z (10 months ago)
- Last Synced: 2025-05-08T10:28:34.700Z (9 months ago)
- Topics: bigbluebutton, bigbluebutton-api, php
- Language: PHP
- Homepage: https://github.com/bigbluebutton/bigbluebutton/
- Size: 1.28 MB
- Stars: 188
- Watchers: 21
- Forks: 200
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-bigbluebutton - PHP - BigBlueButton API library for PHP. `LGPL-3.0` (Libraries / Video Management)
README
# BigBlueButton API for PHP
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fbigbluebutton%2Fbigbluebutton-api-php?ref=badge_shield)
The official and easy to use **BigBlueButton API for PHP**, makes easy for developers to use [BigBlueButton][bbb] API for **PHP 7.4+**.
[](https://packagist.org/packages/bigbluebutton/bigbluebutton-api-php)
[](https://scrutinizer-ci.com/g/bigbluebutton/bigbluebutton-api-php/build-status/master)
[](https://scrutinizer-ci.com/g/bigbluebutton/bigbluebutton-api-php/?branch=master)
[](https://scrutinizer-ci.com/g/bigbluebutton/bigbluebutton-api-php/?branch=master)
[](https://twitter.com/bigbluebutton)
[](https://www.php.net/supported-versions.php)
[](https://www.php.net/supported-versions.php)
[](https://www.php.net/supported-versions.php)
[](https://www.php.net/supported-versions.php)
## Installation and usage
The [wiki] contains all the documentation related to the PHP library. We have also written a samples to show a full
install and usage example.
## Submitting bugs and feature requests
Bugs and feature request are tracked on [GitHub](https://github.com/bigbluebutton/bigbluebutton-api-php/issues)
## Contributing guidelines
### Code Quality 1: Style
Make sure the code style configuration is applied by running PHPCS-Fixer.
```bash
# using an alias
$ composer cs-fix
```
### Code Quality 2: Static code analysis
PHPStan shall be used for static code analysis by running the command below:
```bash
# using an alias
$ composer code-check
# or the same w/o alias
$ ./vendor/bin/phpstan analyse
```
### Code Quality 3: Tests
For every implemented feature add unit tests and check all is green by running the command below.
```bash
# using an alias
$ composer code-test
# or the same w/o alias
./vendor/bin/phpunit
```
To run a single test
```bash
# using an alias
$ composer code-test -- --filter BigBlueButtonTest::testApiVersion
# or the same w/o alias
./vendor/bin/phpunit --filter BigBlueButtonTest::testApiVersion
```
A code-coverage report will be created along with the tests. This report will be stored in:
````
./var/coverage/
````
In case of trouble with the creation of the code-coverage report (e.g. local environment does not fulfill requirements)
the creation can be skipped with:
```bash
# using an alias
$ composer code-test -- --no-coverage
```
**Remark:**
Some test will connect to an existing BBB-server, which is specified in the `.env`-file. You
can specify your own BBB-server by copy that file into the same folder and name it `.env.local`.
Exchange the credentials `BBB_SERVER_BASE_URL` and `BBB_SECRET` to your server's values.
Since this new file (`.env.local`) takes precedence over the main file (`.env`), you will now test
with your own server.
[bbb]: http://bigbluebutton.org
[composer]: https://getcomposer.org
[INSTALL]: samples/README.md
[wiki]: https://github.com/bigbluebutton/bigbluebutton-api-php/wiki
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fbigbluebutton%2Fbigbluebutton-api-php?ref=badge_large)