escolalms/courses-import-export

Escola Headless LMS Courses Import Export

0.1.22 2024-05-23 06:27 UTC

Requires

• php: >=7.4
• escolalms/core: ^1
• laravel/framework: >=8.0
• zanysoft/laravel-zip: ^2

Requires (Dev)

• escolalms/auth: ^0
• escolalms/courses: ^0.4
• escolalms/headless-h5p: ^0.4
• escolalms/settings: ^0
• escolalms/topic-types: ^0
• orchestra/testbench: >=7.0
• phpunit/phpunit: ^9.0

MIT

• Mateusz Wojczal

README

What does it do

This package is responsible for dealing courses in .ulam format

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

Importing the courses in ulam format.

3. Cloning

Installing

• composer require escolalms/course-import-export
• php artisan db:seed --class="EscolaLms\CoursesImportExport\Database\Seeders\CoursesExportImportPermissionSeeder"

Endpoints

All the endpoints are defined in swagger

Tests

Run ./vendor/bin/phpunit to run tests. See tests folder as it's quite good staring point as documentation appendix.

Test details

Events

1. CloneCourseStarted - event dispatched after course cloning is started.
2. CloneCourseFailed - event dispatched after unsuccessful course cloning.
3. CloneCourseFinished - event dispatched after successfully course cloning.

Permissions

Permissions are defined in seeder