Arcanedev\Support\PackageServiceProvider

Complexity

Total Complexity

14

Size/Duplication

Total Lines	222
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

76.27%

Importance

Changes	7
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getConfigFolder()	0	4	1
	getBasePath()	0	1	?
A	getConfigKey()	0	4	1
A	getConfigFile()	0	4	1
A	hasPackageConfig()	0	4	1
A	boot()	0	6	1
A	setup()	0	6	1
A	registerConfig()	0	10	2
A	registerMultipleConfigs()	0	8	2
A	checkPackageName()	0	8	2
B	setupPaths()	0	32	1
A	getSourcePath()	0	4	1

<?php namespace Arcanedev\Support;

use Arcanedev\Support\Exceptions\PackageException;

/**
 * Class     PackageServiceProvider
 *
 * @package  Arcanedev\Support\Laravel
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 *
 * @todo     Redo the PackageServiceProvider
 */
abstract class PackageServiceProvider extends ServiceProvider
{
    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Vendor name.
     *
     * @var string
     */
    protected $vendor       = 'vendor';

    /**
     * Package name.
     *
     * @var string
     */
    protected $package      = '';

    /**
     * Package base path.
     *
     * @var string
     */
    protected $basePath     = '';

    /**
     * Paths collection.
     *
     * @var array
     */
    protected $paths        = [];

    /**
     * Merge multiple config files into one instance (package name as root key)
     *
     * @var bool
     */
    protected $multiConfigs = false;

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get config folder.
     *
     * @return string
     */
    protected function getConfigFolder()
    {
        return realpath($this->getBasePath() . DS .'config');
    }

    /**
     * Get the base path of the package.
     *
     * @return string
     */
    abstract public function getBasePath();

    /**
     * Get config key.
     *
     * @return string
     */
    protected function getConfigKey()
    {
        return str_slug($this->package);
    }

    /**
     * Get config file path
     *
     * @return string
     */
    protected function getConfigFile()
    {
        return $this->getConfigFolder() . DS . $this->package . '.php';
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Boot the service provider.
     */
    public function boot()
    {
        parent::boot();

        $this->checkPackageName();
    }

    /* ------------------------------------------------------------------------------------------------
     |  Package Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Setup package path and stuff.
     */
    protected function setup()
    {
        $this->checkPackageName();
        $this->setupPaths();
        $this->registerConfig();
    }

    /**
     * Register configs.
     *
     * @param  string  $separator
     */
    protected function registerConfig($separator = '.')
    {
        if ($this->multiConfigs) {
            $this->registerMultipleConfigs($separator);

            return;
        }

        $this->mergeConfigFrom($this->getConfigFile(), $this->getConfigKey());
    }

    /**
     * Register all package configs.
     *
     * @param  string  $separator
     */
    private function registerMultipleConfigs($separator = '.')
    {
        foreach (glob($this->getConfigFolder() . '/*.php') as $configPath) {
            $key = $this->getConfigKey() . $separator . basename($configPath, '.php');

            $this->mergeConfigFrom($configPath, $key);
        }
    }

    /* ------------------------------------------------------------------------------------------------
     |  Check Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Check package name
     *
     * @throws PackageException
     */
    private function checkPackageName()
    {
        if ( ! empty($this->package) ) {
            return;
        }

        throw new PackageException('You must specify the name of the package');
    }

    /**
     * Check if has the base config.
     *
     * @return bool
     */
    protected function hasPackageConfig()
    {
        return $this->getConfigFile() !== false;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Setup paths.
     *
     * @return self
     */
    private function setupPaths()
    {
        $this->basePath = $this->getBasePath();
        $this->paths    = [
            'config'    => [
                'src'       => $this->getSourcePath('config'),
                'dest'      => config_path('%s'),
            ],
            'migrations' => [
                'src'       => $this->getSourcePath('database/migrations'),
                'dest'      => database_path('migrations/%s_%s'),
            ],
            'views'     => [
                'src'       => $this->getSourcePath('resources/views'),
                'dest'      => base_path('resources/views/' . $this->vendor . '/%s'),
            ],
            'trans'     => [
                'src'       => $this->getSourcePath('resources/lang'),
                'dest'      => base_path('resources/lang/%s'),
            ],
            'assets'    => [
                'src'       => $this->getSourcePath('resources/assets'),
                'dest'      => public_path('vendor/%s'),
            ],
            'seeds'     => [
                'src'       => $this->getSourcePath('src/Seeds'),
                'dest'      => database_path('seeds/%s'),
            ],
        ];

        return $this;
    }

    /**
     * Get source path.
     *
     * @param  string  $path
     *
     * @return string
     */
    private function getSourcePath($path)
    {
        return str_replace('/', DS, $this->basePath . DS . $path);
    }
}