Package: courses-import-export
Generated from api/packages/courses-import-export
Source: api/packages/courses-import-export · imported version 0.1.24. The sections after the README are extracted from the code on every docs build.
README
Section titled “README”What does it do
Section titled “What does it do”This package is responsible for dealing courses in .ulam format
1. Exporting
Section titled “1. Exporting”Export do create zip package in ulam format with content.json and all essential assets. Export Resource is used for this.
2. Importing
Section titled “2. Importing”Importing the courses in ulam format.
3. Cloning
Section titled “3. Cloning”Installing
Section titled “Installing”composer require ulams/course-import-exportphp artisan db:seed --class="Ulams\CoursesImportExport\Database\Seeders\CoursesExportImportPermissionSeeder"
Endpoints
Section titled “Endpoints”All the endpoints are defined in swagger
Run ./vendor/bin/phpunit to run tests. See tests folder as it’s quite good staring point as documentation appendix.
Test details
Events
Section titled “Events”CloneCourseStarted- event dispatched after course cloning is started.CloneCourseFailed- event dispatched after unsuccessful course cloning.CloneCourseFinished- event dispatched after successfully course cloning.
Permissions
Section titled “Permissions”Permissions are defined in seeder
More documentation in the package
Section titled “More documentation in the package”API endpoints
Section titled “API endpoints”| Method | Path | Auth | Action |
|---|---|---|---|
GET |
/api/admin/courses/{course}/clone |
yes | CourseExportImportAPIController@clone |
GET |
/api/admin/courses/{course}/export |
yes | CourseExportImportAPIController@export |
POST |
/api/admin/courses/zip/import |
yes | CourseExportImportAPIController@import |
Permissions
Section titled “Permissions”| Permission | Seeded for roles | Constant |
|---|---|---|
course-import-export_import |
admin | CoursesImportExportPermissionsEnum::COURSES_IMPORT |
course-import-export_export |
admin | CoursesImportExportPermissionsEnum::COURSES_EXPORT |
course-import-export_export_authored |
admin | CoursesImportExportPermissionsEnum::COURSES_EXPORT_OWNED |
course-import-export_clone |
admin | CoursesImportExportPermissionsEnum::COURSES_CLONE |
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 |
|---|---|---|
CloneCourseFailedEvent |
||
CloneCourseFinishedEvent |
||
CloneCourseStartedEvent |
Artisan commands
Section titled “Artisan commands”None.
Scheduled jobs
Section titled “Scheduled jobs”None.
Environment variables read
Section titled “Environment variables read”None.