README.md

Package Manager

Introduction

Package Manager helps reducing the package creation time. Therefore it supports some basic providers for laravel packages.

This package plays nicely with the laravel plugin seeder package.

Just create a new plugin with composer create-package ipunkt/laravel-package YOUR-PACKAGE-NAME and you are able to start with all the package manager supports out of the box.

Installation

Add this package as dependency by using composer require ipunkt/laravel-package-manager:^1.0

Usage

We suggest using a Package Service Provider extending the Illuminate\Support\AggregateServiceProvider and register all your package related providers as attribute like so:

<?php

namespace MyPackage\Providers;

use Illuminate\Support\AggregateServiceProvider;

class MyPackageServiceProvider extends AggregateServiceProvider
{
	/**
	 * The provider class names.
	 *
	 * @var array
	 */
	protected $providers = [
		ConfigProvider::class,
		BindingsProvider::class,
		ArtisanProvider::class,
		MigrationsProvider::class,
		TranslationsProvider::class,
		BladeProvider::class,
		RoutesProvider::class,
		ViewProvider::class,
		EventsProvider::class,
	];
}

And in your composer.json simply auto-register only your aggregate service provider like so:

{
	"extra": {
        "laravel": {
            "providers": [
                "MyPackage\\Providers\\MyPackageServiceProvider"
            ]
        }
    }
}

Base Service Providers included

We include various service providers for the most common package needs. So you can simply use / extend them and at it to your package service provider.

Package Configuration

If you want to register package configuration you have to extend the ConfigurationServiceProvider.

First of all, please add a protected $packagePath to your extended service provider class and give it a value for the package root folder like so: protected $packagePath = __DIR__ . '/../../';. This is necessary to mark your files relative to the package root.

You have to add your configuration files in attribute $configurationFiles. File by file as array item. If you want to give an alias for config you have to set is array key. For example:

Within your package you have a config/config.php and you want to have it published and merged as my-package you have to set it like so

'my-package' => 'config/config.php'

Then you can get config values by using config('my-package.).

Routes

For providing routes you have to extend the RouteServiceProvider.

First of all, please add a protected $packagePath to your extended service provider class and give it a value for the package root folder like so: protected $packagePath = __DIR__ . '/../../';. This is necessary to mark your files relative to the package root.

Just set $routesNamespace, $routesMiddleware and $routesFile to your needs and you are ready to go. For registering various routes you should have one provider for each type of routes file (api, web, ...).

Views / Templates

We provide the ViewServiceProvider for extension.

First of all, please add a protected $packagePath to your extended service provider class and give it a value for the package root folder like so: protected $packagePath = __DIR__ . '/../../';. This is necessary to mark your files relative to the package root.

You have to set the $namespace to your package based identifier. The $templatesFolder is set to the resources/views by default, you can override it.

Database Migrations

We provide the MigrationServiceProvider to provide database migration files from package.

First of all, please add a protected $packagePath to your extended service provider class and give it a value for the package root folder like so: protected $packagePath = __DIR__ . '/../../';. This is necessary to mark your files relative to the package root.

You have to set the $migrationsFolder to your package migrations.

Translations

We provide the TranslationServiceProvider for extension.

First of all, please add a protected $packagePath to your extended service provider class and give it a value for the package root folder like so: protected $packagePath = __DIR__ . '/../../';. This is necessary to mark your files relative to the package root.

You have to set the $namespace to your package based identifier. The $translationsFolder is set to the resources/lang by default, you can override it.

For the new implemented way for json files we also support the $useJson flag. When true the given files have to be json format.

Artisan Commands

For registering artisan console command we provide the ArtisanServiceProvider.

You have to fill the $commands array with your commands. If you provide a key this key will be the key for registration within the IoC container of laravel. The value should be the command class name like SuperCommand::class or a string e.g. SuperCommand which gets resolved to lookup a method registerSuperCommand within the service provider (protected at least to get called). So you can register more complex commands by using a separate method.

By default artisan commands will registered only on console runs. If you want to change that behaviour you can overwrite the value of $registerOnlyForConsole to make that happen.

Aliases

We provide an AliasServiceProvider to register all aliases by hand. But you should provide aliases by the new package discovery:

{
	"extra": {
		"laravel": {
			"providers": [
				"YourProvider"
			],
			"aliases": {
				"Alias": "Path\\To\\Facade"
			}
		}
	},
}

Common Resolutions

Namespace for views, config, translations, ...

Your aggregated package provider should provide a constant namespace identifier for your package. So you can re-use the same value in all your single package providers consistently.

License

Package Manager is open-sourced software licensed under the MIT license