BigBlueButton API for PHP v6.0.0

Changed

• Bump minimum PHP version to 8.1 by @SamuelWei in #171
• Bump symfony dependencies, remove EOL versions by @SamuelWei in #179
• Remove deprecations by @SamuelWei in #172
• Refactor using native ones by @SamuelWei in #186
• Improved code quality by @FelixJacobi in #188

Breaking

• The methods setClientUrl()/getClientUrl() from BigBlueButton\Parameters\JoinMeetingParameters have been removed
• All enum-styled classes with constants have been converted to native PHP enums
• All enum were moved the BigBlueButton\Enum namespace
• This library now requires at lease PHP 8.1
• Support for using a user or moderator password on getting meeting information or joining a meeting has been removed since BigBlueButton itself deprecated it. Use roles instead.
• Support for Symfony 3.x and 4.x dependencies have been dropped due to both versions being End of life. Symfony 7.x have been added.
• Code have been refactored using rectorphp/rector. All properties and methods are now fully typed. This may breaks your code when you extended classes.
• The code bases now uses declare(strict_types=1);, this may breaks, when you passed wrong types to previously not fully typed methods
• Some method parameters does not accept string anymore, you must use the respective enum explicitly
• The constructor parameter $hasingAlgorithm of BigBlueButton\BigBlueButton now takes a BigBlueButton\Enum\HashingAlgorithm enum instead of a string
• The $hooksListParameters parameter to BigBlueButton\BigBlueButton::getHooksListUrl() and BigBlueButton\BigBlueButton::getHooksListUrl() is now mandatory, passing null is no longer supported
• The BigBlueButton\Core\ApiMethod class has been removed, use the BigBlueButton\Enum\ApiMethod enum instead
• The BigBlueButton\Core\GuestPolicy class has been removed, use the BigBlueButton\Enum\GuestPolicy enum instead
• The BigBlueButton\Core\MeetingLayout class has been removed, use the BigBlueButton\Enum\MeetingLayout enum instead
• The getPlayback*() methods from BigBlueButton\Core\Record has been removed since their only returned information of the first record. Pick the correct record from getPlaybackFormats() instead
• The abstract class BigBlueButton\Enum\Enum has been removed
• The setConfigToken() and getConfigToken() method from BigBlueButton\Parameters\JoinMeetingParameters have been removed
• The BigBlueButton\Responses\DeleteRecordingsResponse::isInvalidId() method has been removed, use BigBlueButton\Responses\DeleteRecordingsResponse::isNotFound() instead

Deprecated

• Configuring the BigBlueButton\BigBlueButton object using the BBB_SECURITY_SALT/BBB_SECRET and BBB_SERVER_BASE_URL has been deprecated for security and type-safety reasons and will be removed in 7.0. Configure the object using constructor parameters instead.

Full Changelog: 5.4.0...6.0.0

BigBlueButton API for PHP v5.4.0

This last release of the 5.x line includes many deprecations for the upcoming 6.0 release and a few new features.
6.0 will be released in the near future with same feature set as this release except for the deprecated features.

Added

• hooksList() and getHooksListUrl() BigBlueButton\BigBlueButton
• getParentMeetingID() in BigBlueButton\Core\Meeting (used for Breakout rooms)
• setAllowPromoteGuestToModerator() and getAllowPromoteGuestToModerator() in BigBlueButton\Parameters\CreateMeetingParameters
• isMissingHook() and isHookError() in BigBlueButton\Responses\HooksDestroyResponse
• isNotFound() in BigBlueButton\Responses\PublishRecordingsResponse
• isNoRecordings(), isInvalidLang() and isInvalidKind() in BigBlueButton\Responses\PutRecordingTextTrackResponse
• isNotFound() in BigBlueButton\Responses\UpdateRecordingsResponse

Deprecated

• Constructing BigBlueButton/BigBlueButton without host and secret as arguments (Using BBB_SECURITY_SALT or BBB_SECRET environment variables is deprecated for security reasons)
• Namespace of ApiMethod (BigBlueButton\Core -> BigBlueButton\Enum)
• Namespace of GuestPolicy (BigBlueButton\Core -> BigBlueButton\Enum)
• Namespace of MeetingLayout (BigBlueButton\Core -> BigBlueButton\Enum)
• BigBlueButton\Enum\Feature::IMPORT_PRESENTATION_WITHANNOTATIONS_FROM_BREAKOUTROOMS (use BigBlueButton\Enum\Feature::IMPORT_PRESENTATION_WITH_ANNOTATIONS_FROM_BREAKOUT_ROOMS instead)
• BigBlueButton\Enum\Feature::IMPORT_SHARED_NOTES_FROM_BREAKOUTROOMS (use BigBlueButton\Enum\Feature::IMPORT_SHARED_NOTES_FROM_BREAKOUT_ROOMS instead)
• getters and setters for lockSettingsDisableNote, learningDashboardEnabled, virtualBackgroundsDisabled and breakoutRoomsEnabled in BigBlueButton\Parameters\CreateMeetingParameters (use disabledFeatures instead)
• Old flash client setting clientURL in BigBlueButton\Parameters\JoinMeetingParameters
• BigBlueButton\Parameters\JoinMeetingParameters::MODERATOR (use BigBlueButton\Enum\Role::MODERATOR instead)
• BigBlueButton\Parameters\JoinMeetingParameters::VIEWER (use BigBlueButton\Enum\Role::VIEWER instead)
• BigBlueButton\Responses\DeleteRecordingsResponse::KEY_INVALID_ID (use BigBlueButton\Responses\DeleteRecordingsResponse::KEY_NOT_FOUND instead)
• isInvalidId() in BigBlueButton\Responses\DeleteRecordingsResponse (use isNotFound() instead)

Full Changelog: 5.3.0...5.4.0

BigBlueButton API for PHP v5.3.0

This second last release of the 5.x line just including some cleanup in preparation for 6.0. 6.0 will be released in the near future with same feature set as this release except for the deprecated features.

Deprecated

• Deprecate password in CreateMeetingResponse

Full Changelog: 5.2.0...5.3.0

BigBlueButton API for PHP v5.2.0

Added

• CreateMeetingParameters
  • preUploadedPresentation and preUploadedPresentationName
• Feature Enum (used in CreateMeetingParameters)
  • CAMERA_AS_CONTENT
  • SNAPSHOT_OF_CURRENT_SLIDE
  • DOWNLOAD_PRESENTATION_ORIGINAL_FILE
  • DOWNLOAD_PRESENTATION_CONVERTED_TO_PDF
  • TIMER

Changed

• Feature Enum (used in CreateMeetingParameters)
  • Renamed IMPORT_PRESENTATION_WITHANNOTATIONS_FROM_BREAKOUTROOMS to IMPORT_PRESENTATION_WITH_ANNOTATIONS_FROM_BREAKOUT_ROOMS (old const deprecated)
• Renamed IMPORT_SHARED_NOTES_FROM_BREAKOUTROOMS to IMPORT_SHARED_NOTES_FROM_BREAKOUT_ROOMS (old const deprecated)
• Removed marc-mabe/php-enum

Fixed

• Path error in pslam-clear composer script
• Missing docs in CreateMeetingParameters
  • isNotifyRecordingIsOn and setNotifyRecordingIsOn
  • isRemindRecordingIsOn and setRemindRecordingIsOn
  • isRecordFullDurationMedia and setRecordFullDurationMedia
  • isLockSettingsHideViewersCursor and setLockSettingsHideViewersCursor
  • getMeetingExpireIfNoUserJoinedInMinutes and setMeetingExpireIfNoUserJoinedInMinutes
  • getMeetingExpireWhenLastUserLeftInMinutes and setMeetingExpireWhenLastUserLeftInMinutes
  • getMeetingCameraCap and setMeetingCameraCap
  • isPreUploadedPresentationOverrideDefault and setPreUploadedPresentationOverrideDefault
  • getPresentationUploadExternalUrl and setPresentationUploadExternalUrl
  • getPresentationUploadExternalDescription and setPresentationUploadExternalDescription

Deprecated

• Feature Enum (used in CreateMeetingParameters)

  • IMPORT_PRESENTATION_WITHANNOTATIONS_FROM_BREAKOUTROOMS (use IMPORT_PRESENTATION_WITH_ANNOTATIONS_FROM_BREAKOUT_ROOMS instead)
  • IMPORT_SHARED_NOTES_FROM_BREAKOUTROOMS (use IMPORT_SHARED_NOTES_FROM_BREAKOUT_ROOMS instead)

Full Changelog: 5.1.0...5.2.0

BigBlueButton API for PHP v5.1.0

Added

• Set checksum algorithm via the forth constructor parameter (default SHA-1)
• CreateMeetingParameters
  • BreakoutRoomsGroups
  • disabledFeatures and disabledFeaturesExclude
  • lockSettingsHideViewersCursor
  • meetingCameraCap
  • meetingExpireIfNoUserJoinedInMinutes
  • meetingExpireWhenLastUserLeftInMinutes
  • preUploadedPresentationOverrideDefault
  • notifyRecordingIsOn
  • remindRecordingIsOn
  • recordFullDurationMedia
  • presentationUploadExternalUrl
  • presentationUploadExternalDescription
• JoinMeetingParameters
  • errorRedirectUrl

Changed

• CreateMeetingParameters
  • Renamed setLockSettingsDisableNote to setLockSettingsDisableNotes (setLockSettingsDisableNote deprecated)
• JoinMeetingParameters
  • Pass role instead of password in constructor
• Updated PHPUnit to version 9

Fixed

• Fix functional tests
• Fix CI not running for experimental versions

Deprecated

• CreateMeetingParameters
  • configToken (old flash client parameter)
  • setLockSettingsDisableNote (use setLockSettingsDisableNotes instead)
  • getAttendeePW / setAttendeePW and getModeratorPW / setModeratorPW (use roles instead)
  • setLockSettingsDisableNote and isLockSettingsDisableNote (use disabledFeatures instead)
  • setLearningDashboardEnabled and isLearningDashboardEnabled (use disabledFeatures instead)
  • setVirtualBackgroundsDisabled and isVirtualBackgroundsDisabled (use disabledFeatures instead)
  • setBreakoutRoomsEnabled and isBreakoutRoomsEnabled (use disabledFeatures instead)
• JoinMeetingParameters
  • Password parameter in constructor (use roles instead)
• EndMeetingParameters
  • Password parameter in constructor (not needed anymore)
• Meeting
  • getAttendeePassword and getModeratorPassword (use roles instead)

Special thanks to @SamuelWei, who contributed the major portion to this release.

BigBlueButton API for PHP v5.0.0

Added

• Added native PHP return types for all methods in the codebase. Please adjust your own code when extending classes from the library.

Changed

• Minimum required PHP version is now 7.4.
• Classes marked as @final in previous versions are now final, except for BigBlueButton\BigBlueButton. You can no longer extend them.

Deprecated

• Please stop extending BigBlueButton\BigBlueButton in your own code, it might become final in version 6.0.

Removed

• The getPlaybackType(), getPlaybackUrl() and getPlaybackLength() methods of BigBlueButton\Core\Record have been removed, please use getPlaybackFormats() instead.
• The old getters and setters from BigBlueButton\Parameters\* classes have been removed, please use the new magic getters and setters instead. You can find the name of the replacing method in the @deprecated annotation in the source code of version 4.3 before the upgrade.
• The isJoinViaHtml5() and setJoinViaHtml5() methods from BigBlueButton\Parameters\JoinMeetingParameters have been removed without replacement, because the parameter has been removed from the BigBlueButton API and has no effect anymore.

BigBlueButton API for PHP v4.3.0

Added

• add insertDocument endpoint

Fixed

• sync upstream

Changed

• deprecate joinViaHtml5
• update php-cs-fixer, change to symfony rule set

BigBlueButton API for PHP v4.2.0

Added

• Support for new parameters introduced in BBB 2.4.3:
  • CreateMeeting: AllowRequestsWithoutSession and VirtualBackgroundsDisabled
• Support for parameters introduced a long time ago, but were missing:
  • CreateMeeting: BreakoutRoomsEnabled, BreakoutRoomsPrivateChatEnabled and BreakoutRoomsRecord
• Getter for ApiVersion and BbbVersion to ApiVersionResponse class

Fixed

• Expose all playback formats of a record (getPlaybackFormats()) instead of only the first one

Changed

• Transport Interface can now be overwritten for extending the BigBlueButton class (private -> protected)

BigBlueButton API for PHP v4.1.0

Added

• add parameter typing
• add support for new parameters introduced in BBB 2.4
  • CreateMeeting: meetingLayout, learningDashboardEnabled, learningDashboardCleanupDelayInMinutes, allowModsToEjectCameras
  • JoinMeeting: role, excludeFromDashboard

Changed

• remove deprecated support for config XML

BigBlueButton API for PHP v4.0.1

Fixed

• JoinMeetingParameters: Fixed typo in magic method annotation