Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce document classes #245

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from

Conversation

DigitalTimK
Copy link
Contributor

Background

The current way to manage documents is very inconsistent (following the same inconsistent way as on the BBB-Server API side). Sometimes they are called documents and sometimes presentations. For example there is currently a class called "SomeThingDocument" but has a addPresentation-function.
In addition the addPresentation-function is unclear regarding their parameter and how they will support the required result. Either by URL or by embedded data stream. So a separation into two cases (=classes) makes senses.
On top the addPresentation-function required the user to pass the data-stream directly.

This PR will

  • introduce DocumentUrl-class and DocumentFile-class (including their related abstract class and interface class)
  • add related tests
  • no passing of data-stream directly. Only the filename is required and this is done by the classes automatically.
  • deprecate former presentation-related function and classes

This PR will close #244

src/Parameters/DocumentParametersTrait.php Outdated Show resolved Hide resolved
src/Parameters/DocumentParametersTrait.php Outdated Show resolved Hide resolved
src/Parameters/DocumentParametersTrait.php Outdated Show resolved Hide resolved
src/Parameters/DocumentParametersTrait.php Outdated Show resolved Hide resolved
src/Parameters/DocumentParametersTrait.php Outdated Show resolved Hide resolved
tests/fixtures/presentation_with_url.xml Outdated Show resolved Hide resolved
@GhaziTriki GhaziTriki added this to the 3.0.0 milestone May 5, 2024
src/Core/DocumentUrl.php Show resolved Hide resolved
src/Core/DocumentUrl.php Outdated Show resolved Hide resolved
src/Core/DocumentUrl.php Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants