insolutions/laravel-files

Models and endpoints for files management


License
MIT

Documentation

README

This README of generic order backend package

What is this repository for?

Package covers sample package functionality including database, routes etc.

Limitations

use ins/auth >1.0.3 if needed (package ins/auth is not mandatory)

How do I get set up?

1. composer.json

Link repository of package:

"repositories": [
	{
		"type": "url",
		"url": "https://bitbucket.org/in-solutions/laravel-files"
	}
]

and then run

composer require ins/files

2. Publish sources

php artisan vendor:publish

  • publishes db migrations into /database/sql/ins/files
  • publishes listeners/subscribers into /app/Listeners

3. Register package ServiceProvider

FOR LARAVEL >5.5 is Service Provider registered automatically by composer.json and you can skip this step.

in file app/config.php extend array by line:

"providers" => [
	
	...
		
	INS\Package\ServiceProvider::class,		
	
]

4. Register subscriber

in file app/Providers/EventServiceProvider.php extend array by line:

protected $subscribe = [
	
	...
	
	'App\Listeners\FilesSubscriber',
	
];

Modules interface

Packages can not be dependent on any project-specific application. Only allowed dependencies are allowed to other laravel packages.

Project specific actions after some functionality (Events) covered by package can be defined in Listeners published into app/Listeners folder when installing composer package.

Package Listener: app/Listeners/FilesSubscriber.php

Subscribed events:

  • onEntityCreated: when new order is created, $event->order = Order model

Who do I talk to?

Jakub Lajmon jakub@lajmon.name