PackageServiceProvider::resolveBasePath() - Code Metrics - Inspection of "Merge pull request #35 from ARCANEDEV/develop" - ARCANEDEV/Support - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 184560...9805df )

by ARCANEDEV

created 2020-03-04 08:19 UTC

PackageServiceProvider::resolveBasePath() A

↳ Parent: PackageServiceProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	6
ccs	3
cts	3
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Arcanedev\Support\Providers;

use Arcanedev\Support\Exceptions\PackageException;
use Arcanedev\Support\Providers\Concerns\{HasConfig, HasFactories, HasMigrations, HasTranslations, HasViews};
use Illuminate\Contracts\Foundation\Application;
use ReflectionClass;

/**
 * Class     PackageServiceProvider
 *
 * @package  Arcanedev\Support\Providers
 * @author   ARCANEDEV <[email protected]>
 */
abstract class PackageServiceProvider extends ServiceProvider
{
    /* -----------------------------------------------------------------
     |  Traits
     | -----------------------------------------------------------------
     */

    use HasConfig,
        HasFactories,
        HasMigrations,
        HasTranslations,
        HasViews;

    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * Vendor name.
     *
     * @var string
     */
    protected $vendor = 'arcanedev';

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

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

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Create a new service provider instance.
     *
     * @param  \Illuminate\Contracts\Foundation\Application  $app
     */
    public function __construct(Application $app)
    {
        parent::__construct($app);

        $this->basePath = $this->resolveBasePath();
    }

    /**
     * Resolve the base path of the package.
     *
     * @return string
     */
    protected function resolveBasePath()
    {
        return dirname(
            (new ReflectionClass($this))->getFileName(), 2
        );
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the base path of the package.
     *
     * @return string
     */
    public function getBasePath()
    {
        return $this->basePath;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Register the service provider.
     */
    public function register()
    {
        parent::register();

        $this->checkPackageName();
    }

    /* -----------------------------------------------------------------
     |  Package Methods
     | -----------------------------------------------------------------
     */

    /**
     * Publish all the package files.
     *
     * @param  bool  $load
     */
    protected function publishAll($load = true)
    {
        $this->publishConfig();
        $this->publishMigrations();
        $this->publishViews($load);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->publishTranslations($load);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->publishFactories();
    }

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check package name.
     *
     * @throws \Arcanedev\Support\Exceptions\PackageException
     */
    private function checkPackageName(): void
    {
        if (empty($this->vendor) || empty($this->package)) {
            throw PackageException::unspecifiedName();
        }
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Arcanedev\Support\Providers;
6
7		use Arcanedev\Support\Exceptions\PackageException;
8		use Arcanedev\Support\Providers\Concerns\{HasConfig, HasFactories, HasMigrations, HasTranslations, HasViews};
9		use Illuminate\Contracts\Foundation\Application;
10		use ReflectionClass;
11
12		/**
13		* Class PackageServiceProvider
14		*
15		* @package Arcanedev\Support\Providers
16		* @author ARCANEDEV <[email protected]>
17		*/
18		abstract class PackageServiceProvider extends ServiceProvider
19		{
20		/* -----------------------------------------------------------------
21		\| Traits
22		\| -----------------------------------------------------------------
23		*/
24
25		use HasConfig,
26		HasFactories,
27		HasMigrations,
28		HasTranslations,
29		HasViews;
30
31		/* -----------------------------------------------------------------
32		\| Properties
33		\| -----------------------------------------------------------------
34		*/
35
36		/**
37		* Vendor name.
38		*
39		* @var string
40		*/
41		protected $vendor = 'arcanedev';
42
43		/**
44		* Package name.
45		*
46		* @var string
47		*/
48		protected $package = '';
49
50		/**
51		* Package base path.
52		*
53		* @var string
54		*/
55		protected $basePath;
56
57		/* -----------------------------------------------------------------
58		\| Constructor
59		\| -----------------------------------------------------------------
60		*/
61
62		/**
63		* Create a new service provider instance.
64		*
65		* @param \Illuminate\Contracts\Foundation\Application $app
66		*/
67	18	public function __construct(Application $app)
68		{
69	18	parent::__construct($app);
70
71	18	$this->basePath = $this->resolveBasePath();
72	18	}
73
74		/**
75		* Resolve the base path of the package.
76		*
77		* @return string
78		*/
79	18	protected function resolveBasePath()
80		{
81	18	return dirname(
82	18	(new ReflectionClass($this))->getFileName(), 2
83		);
84		}
85
86		/* -----------------------------------------------------------------
87		\| Getters & Setters
88		\| -----------------------------------------------------------------
89		*/
90
91		/**
92		* Get the base path of the package.
93		*
94		* @return string
95		*/
96	18	public function getBasePath()
97		{
98	18	return $this->basePath;
99		}
100
101		/* -----------------------------------------------------------------
102		\| Main Methods
103		\| -----------------------------------------------------------------
104		*/
105
106		/**
107		* Register the service provider.
108		*/
109	18	public function register()
110		{
111	18	parent::register();
112
113	18	$this->checkPackageName();
114	18	}
115
116		/* -----------------------------------------------------------------
117		\| Package Methods
118		\| -----------------------------------------------------------------
119		*/
120
121		/**
122		* Publish all the package files.
123		*
124		* @param bool $load
125		*/
126		protected function publishAll($load = true)
127		{
128		$this->publishConfig();
129		$this->publishMigrations();
130		$this->publishViews($load);
		0 ignored issues – show Documentation introduced 2020-03-04 08:19 UTC by Report Bug Copy Issue Report `$load` is of type `boolean`, but the function expects a `string\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
131		$this->publishTranslations($load);
		0 ignored issues – show Documentation introduced 2020-03-04 08:19 UTC by Report Bug Copy Issue Report `$load` is of type `boolean`, but the function expects a `string\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
132		$this->publishFactories();
133		}
134
135		/* -----------------------------------------------------------------
136		\| Check Methods
137		\| -----------------------------------------------------------------
138		*/
139
140		/**
141		* Check package name.
142		*
143		* @throws \Arcanedev\Support\Exceptions\PackageException
144		*/
145	18	private function checkPackageName(): void
146		{
147	18	if (empty($this->vendor) \|\| empty($this->package)) {
148	6	throw PackageException::unspecifiedName();
149		}
150	18	}
151		}
152

ARCANEDEV / Support

Push — master ( 184560...9805df )

PackageServiceProvider::resolveBasePath() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like