escolalms/dictionaries

Escola Headless LMS dictionaries package

0.0.5 2024-04-15 07:12 UTC

Requires

• php: >=8.0
• escolalms/auth: ^0
• escolalms/categories: ^0
• escolalms/core: ^1
• laravel/framework: >=8.0
• maatwebsite/excel: >=3.1

Requires (Dev)

• nunomaduro/larastan: ^1.0
• orchestra/testbench: >=5.0
• phpunit/phpunit: ^9.0

MIT

• Maciej Rymarz

README

What does it do

This package is used for managing dictionaries and their expressions. You can set the number of free views of words from a given dictionary for users who are not assigned. This package is compatible with the purchasing process in Wellms. The dictionary may be a purchasable product.

Entity Relationship Diagrams

The diagram below shows the relationships between entities.

erDiagram
    Dictionary ||--o{ DictionaryWord : "has"
    Dictionary ||--o{ DictionaryUser : "has"
    DictionaryWord ||--o{ DictionaryWordCategory : "has"

    Dictionary {
        string name
        string slug
        int free_views_count
    }

    DictionaryWord {
        string word
        string description
        json data
    }

    DictionaryUser {
        datetime end_date
    }

Loading

Installing

• composer require escolalms/dictionaries
• php artisan migrate
• php artisan db:seed --class="EscolaLms\Dictionaries\Database\Seeders\DictionariesPermissionSeeder"

Endpoints

The endpoints are defined in

Tests

Run ./vendor/bin/phpunit to run tests. Test details

Events

This package does not dispatch any events.

Listeners

This package does not listen for any events.

Permissions

This package contains permissions which you can find in DictionariesPermissionEnum. The default assignment of permissions to roles is carried out after executing the command php artisan db:seed --class="EscolaLms\Dictionaries\Database\Seeders\DictionariesPermissionSeeder"