Displore Core

This is the core package of Displore, it helps you with installing any other (Displore) packages. It also comes with a general notifications and logbook system.

Install

Via Composer

$ composer require displore/core

Afterwards, add the service provider and dump Composer's autoloads. Displore\Core\CoreServiceProvider::class,

Configuration

$ php artisan vendor:publish --tag=displore.core.config

Usage

Installing packages

For example, if you want to install the backend package called Biotope.

$ php artisan displore:install Biotope

Everything is done for you, from composer to the laravel service provider.

Optional flags: --dev (use composer require --dev) --config (treat the given name as a path to a config file)

The --config flag is used the following way:

$ php artisan displore:install app/myconfig.json --config

The installer will then cycle through the json file and install the package, or packages that are listed. This includes setting Laravel specific logic such as providers and aliases. See the documentation, or any of the Displore packages for an example of ta config file.

Notifications

This package provides a notifications system out of the box. The Notifier class is resolved by Laravel. Some examples:

Notifier::notify("You have been tagged in a photo");
Notifier::flash("You Only Read This Once");
Notifier::get()->allForUser(Auth::user());
Notifier::get()->markAsRead($nId);
Notifier::flushOldAndReadFor($timestamp, 'user', Auth::user());

Logbook

To get a simple overview of the contents of you logs, you can use the Logbook class to retrieve and parse all .log files. The Biotope backend package has an example implementation of this functionality.

$files = Logbook::getLogFiles(storage_path('logs'));
$logs = Logbook::compile($files);
$JsonLogs = Logbook::compile($files)->toJson();

Further documentation

To be made.

Change log

Please see changelog for more information what has changed recently.

Testing

In a Laravel application, with Laravel Packager:

$ php artisan packager:git *Displore Github url*
$ php artisan packager:tests Displore Core
$ phpunit

Contributing

Please see contributing for details.

Credits

• JeroenG
• All Contributors

License

The EUPL License. Please see the License File for more information.