escolalms/files

Escola file repository API.

Maintainers

πŸ‘ qunabu

Package info

github.com/EscolaLMS/Files

Type:package

pkg:composer/escolalms/files

Statistics

Installs: 237 676

Dependents: 9

Suggesters: 0

Stars: 0

Open Issues: 0

0.1.29 2023-10-19 09:12 UTC

Requires

Requires (Dev)

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT 56adbd7217a4103652b0583e398e9ba2eec1581d

  • Mariusz GliwiΕ„ski <mariusz.gliwinski.woop@escola.pl>

README

Files browser package

πŸ‘ swagger
πŸ‘ codecov
πŸ‘ phpunit
πŸ‘ downloads
πŸ‘ downloads
πŸ‘ downloads
πŸ‘ Maintainability

What does it do

This package is used to upload, delete and reuse files.

Installing

  • composer require escolalms/files
  • php artisan migrate
  • php artisan db:seed --class="EscolaLms\Files\Database\Seeders\PermissionTableSeeder"

Database

This package adds access_to_directories column to the users table.

Endpoints

All the endpoints are defined in πŸ‘ swagger

Tests

Run ./vendor/bin/phpunit to run tests. πŸ‘ phpunit
πŸ‘ codecov

Events

This package does not dispatch any events.

Listeners

This package listens for events and adds or removes user access to directories.

  • EscolaLms\Auth\Events\AccountConfirmed - add user access to directory avatars/{user_id}

  • EscolaLms\Courses\Events\CourseTutorAssigned - add user access to directory course/{course_id}

  • EscolaLms\Courses\Events\CourseTutorUnassigned - remove user access to directory course/{course_id}

  • EscolaLms\Webinar\Events\WebinarTrainerAssigned - add user access to directory webinar/{webinar_id}

  • EscolaLms\Webinar\Events\WebinarTrainerUnassigned - remove user access to directory webinar/{webinar_id}

  • EscolaLms\StationaryEvents\Events\StationaryEventAuthorAssigned - add user access to directory stationary-events/{stationary_evet_id}

  • EscolaLms\StationaryEvents\Events\StationaryEventAuthorUnassigned - remove user access to directory stationary-events/{stationary_evet_id}

How to use this on frontend

Admin panel

Left menu πŸ‘ Menu

Files browser πŸ‘ List

File finder πŸ‘ File finder

Upload the file to the selected directory πŸ‘ Upload

Permissions

Permissions are defined in seeder