Package: topic-types
Generated from api/packages/topic-types
Source: api/packages/topic-types · imported version 0.2.53. The sections after the README are extracted from the code on every docs build.
README
Section titled “README”Extending package for courses
What does it do
Section titled “What does it do”This repository stores code for Ulams Content Topic types. At the moment there are the following types:
- Audio.
- H5P. Reusable Interactive HTML5 Content
- Image.
- oEmbed. oEmbed is a format for allowing an embedded representation of a URL on third party sites.
- RichText. Markdown rich texts. Like github readme files
- Video. Video with possible conversion to HLS format.
- PDF.
Those types are used for building headless Course.
Installing
Section titled “Installing”This package is installing with package course - See TopicTypes
Adding new Content Types
Section titled “Adding new Content Types”It’s possible to add any new content type, for example HTML Text.
See Courses readme for tutorial
Run ./vendor/bin/phpunit --filter 'Ulams\\TopicTypes\\Tests' to run tests. See tests folder as it’s quite good staring point as documentation appendix.
Test details 
Events
Section titled “Events”Ulams\TopicTypes\Events\TopicTypeChanged=> Event is dispatched when topic type value is changed.
Admin panel
Section titled “Admin panel”Add topic type to lesson
More documentation in the package
Section titled “More documentation in the package”Topic types
Section titled “Topic types”AudioVideoImageRichTextH5POEmbedPDFScormScoCmi5Au
API endpoints
Section titled “API endpoints”None.
Permissions
Section titled “Permissions”None.
Settings
Section titled “Settings”Registered with AdministrableConfig::registerConfig (editable in the admin panel under Configuration → Settings).
None.
Events
Section titled “Events”| Event | Description | Notification templates |
|---|---|---|
TopicTypeChanged |
Notification templates registered here
Section titled “Notification templates registered here”None.
Artisan commands
Section titled “Artisan commands”| Command | Description | Signature |
|---|---|---|
ulams:fill-topic-types-metadata |
Fill the metadata for the specific model | ulams:fill-topic-types-metadata {model} |
ulams:fix-topic-types-paths |
Fixes all topic types paths so they are always in courses/{id} folder | ulams:fix-topic-types-paths |
ulams:fix-type-column-name |
Fixes Topicable DBs column name from old Ulams\Courses\Models\TopicContent\XXX to Ulams\TopicTypes\Models\TopicContent\XXX |
ulams:fix-type-column-name |
Scheduled jobs
Section titled “Scheduled jobs”None.
Environment variables read
Section titled “Environment variables read”None.