Module::isLoadFilesOnBoot() - Code Metrics - Inspection of "include files while booting app." - nWidart/laravel-modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#445)

by Salah

created 2017-12-03 05:21 UTC

Module::isLoadFilesOnBoot() A

↳ Parent: Module

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

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

<?php

namespace Nwidart\Modules;

use Illuminate\Container\Container;
use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Str;
use Illuminate\Support\Traits\Macroable;

abstract class Module extends ServiceProvider
{
    use Macroable;

    /**
     * The laravel|lumen application instance.
     *
     * @var \Illuminate\Contracts\Foundation\Application|Laravel\Lumen\Application
     */
    protected $app;

    /**
     * The module name.
     *
     * @var
     */
    protected $name;

    /**
     * The module path.
     *
     * @var string
     */
    protected $path;

    /**
     * @var array of cached Json objects, keyed by filename
     */
    protected $moduleJson = [];

    /**
     * The constructor.
     *
     * @param Container $app
     * @param $name
     * @param $path
     */
    public function __construct(Container $app, $name, $path)
    {
        parent::__construct($app);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->name = $name;
        $this->path = realpath($path);
    }

    /**
     * Get laravel instance.
     *
     * @return \Illuminate\Contracts\Foundation\Application|Laravel\Lumen\Application
     */
    public function getLaravel()
    {
        return $this->app;
    }

    /**
     * Get name.
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Get name in lower case.
     *
     * @return string
     */
    public function getLowerName()
    {
        return strtolower($this->name);
    }

    /**
     * Get name in studly case.
     *
     * @return string
     */
    public function getStudlyName()
    {
        return Str::studly($this->name);
    }

    /**
     * Get name in snake case.
     *
     * @return string
     */
    public function getSnakeName()
    {
        return Str::snake($this->name);
    }

    /**
     * Get description.
     *
     * @return string
     */
    public function getDescription()
    {
        return $this->get('description');
    }

    /**
     * Get alias.
     *
     * @return string
     */
    public function getAlias()
    {
        return $this->get('alias');
    }

    /**
     * Get priority.
     *
     * @return string
     */
    public function getPriority()
    {
        return $this->get('priority');
    }

    /**
     * Get module requirements.
     *
     * @return array
     */
    public function getRequires()
    {
        return $this->get('requires');
    }

    /**
     * Get path.
     *
     * @return string
     */
    public function getPath()
    {
        return $this->path;
    }

    /**
     * Set path.
     *
     * @param string $path
     *
     * @return $this
     */
    public function setPath($path)
    {
        $this->path = $path;

        return $this;
    }

    /**
     * Bootstrap the application events.
     */
    public function boot()
    {
        if (config('modules.register.translations', true) === true) {
            $this->registerTranslation();
        }

        if ($this->isLoadFilesOnBoot()) {
            $this->registerFiles();
        }

        $this->fireEvent('boot');
    }

    /**
     * Register module's translation.
     *
     * @return void
     */
    protected function registerTranslation()
    {
        $lowerName = $this->getLowerName();

        $langPath = $this->getPath() . '/Resources/lang';

        if (is_dir($langPath)) {
            $this->loadTranslationsFrom($langPath, $lowerName);
        }
    }

    /**
     * Get json contents from the cache, setting as needed.
     *
     * @param string $file
     *
     * @return Json
     */
    public function json($file = null) : Json
    {
        if ($file === null) {
            $file = 'module.json';
        }

        return array_get($this->moduleJson, $file, function () use ($file) {
            return $this->moduleJson[$file] = new Json($this->getPath() . '/' . $file, $this->app['files']);
        });
    }

    /**
     * Get a specific data from json file by given the key.
     *
     * @param string $key
     * @param null $default
     *
     * @return mixed
     */
    public function get(string $key, $default = null)
    {
        return $this->json()->get($key, $default);
    }

    /**
     * Get a specific data from composer.json file by given the key.
     *
     * @param $key
     * @param null $default
     *
     * @return mixed
     */
    public function getComposerAttr($key, $default = null)
    {
        return $this->json('composer.json')->get($key, $default);
    }

    /**
     * Register the module.
     */
    public function register()
    {
        $this->registerAliases();

        $this->registerProviders();

        if ($this->isLoadFilesOnBoot() === false) {
            $this->registerFiles();
        }

        $this->fireEvent('register');
    }

    /**
     * Register the module event.
     *
     * @param string $event
     */
    protected function fireEvent($event)
    {
        $this->app['events']->fire(sprintf('modules.%s.' . $event, $this->getLowerName()), [$this]);
    }
    /**
     * Register the aliases from this module.
     */
    abstract public function registerAliases();

    /**
     * Register the service providers from this module.
     */
    abstract public function registerProviders();

    /**
     * Get the path to the cached *_module.php file.
     *
     * @return string
     */
    abstract public function getCachedServicesPath();

    /**
     * Register the files from this module.
     */
    protected function registerFiles()
    {
        foreach ($this->get('files', []) as $file) {
            include $this->path . '/' . $file;
        }
    }

    /**
     * Handle call __toString.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->getStudlyName();
    }

    /**
     * Determine whether the given status same with the current module status.
     *
     * @param $status
     *
     * @return bool
     */
    public function isStatus($status) : bool
    {
        return $this->get('active', 0) === $status;
    }

    /**
     * Determine whether the current module activated.
     *
     * @return bool
     */
    public function enabled() : bool
    {
        return $this->isStatus(1);
    }

    /**
     * Alternate for "enabled" method.
     *
     * @return bool
     * @deprecated
     */
    public function active()
    {
        return $this->isStatus(1);
    }

    /**
     * Determine whether the current module not activated.
     *
     * @return bool
     * @deprecated
     */
    public function notActive()
    {
        return !$this->active();

    }

    /**
     *  Determine whether the current module not disabled.
     *
     * @return bool
     */
    public function disabled() : bool
    {
        return !$this->enabled();
    }

    /**
     * Set active state for current module.
     *
     * @param $active
     *
     * @return bool
     */
    public function setActive($active)
    {
        return $this->json()->set('active', $active)->save();
    }

    /**
     * Disable the current module.
     */
    public function disable()
    {
        $this->fireEvent('disabling');

        $this->setActive(0);

        $this->fireEvent('disabled');
    }

    /**
     * Enable the current module.
     */
    public function enable()
    {
        $this->fireEvent('enabling');

        $this->setActive(1);

        $this->fireEvent('enabled');
    }

    /**
     * Delete the current module.
     *
     * @return bool
     */
    public function delete()
    {
        return $this->json()->getFilesystem()->deleteDirectory($this->getPath());
    }

    /**
     * Get extra path.
     *
     * @param string $path
     *
     * @return string
     */
    public function getExtraPath(string $path) : string
    {
        return $this->getPath() . '/' . $path;
    }

    /**
     * Handle call to __get method.
     *
     * @param $key
     *
     * @return mixed
     */
    public function __get($key)
    {
        return $this->get($key);
    }

    /**
     * Check if can load files of module on boot method.
     *
     * @return bool
     */
    protected function isLoadFilesOnBoot()
    {
        return config('modules.register.files', 'register') === 'boot' &&
            // force register method if option == boot && app is AsgardCms
            !class_exists('\Modules\Core\Foundation\AsgardCms');
    }
}


1		<?php
2
3		namespace Nwidart\Modules;
4
5		use Illuminate\Container\Container;
6		use Illuminate\Support\ServiceProvider;
7		use Illuminate\Support\Str;
8		use Illuminate\Support\Traits\Macroable;
9
10		abstract class Module extends ServiceProvider
11		{
12		use Macroable;
13
14		/**
15		* The laravel\|lumen application instance.
16		*
17		* @var \Illuminate\Contracts\Foundation\Application\|Laravel\Lumen\Application
18		*/
19		protected $app;
20
21		/**
22		* The module name.
23		*
24		* @var
25		*/
26		protected $name;
27
28		/**
29		* The module path.
30		*
31		* @var string
32		*/
33		protected $path;
34
35		/**
36		* @var array of cached Json objects, keyed by filename
37		*/
38		protected $moduleJson = [];
39
40		/**
41		* The constructor.
42		*
43		* @param Container $app
44		* @param $name
45		* @param $path
46		*/
47	142	public function __construct(Container $app, $name, $path)
48		{
49	142	parent::__construct($app);
		0 ignored issues – show Documentation introduced 2017-07-18 12:51 UTC by Report Bug Copy Issue Report `$app` is of type `object<Illuminate\Container\Container>`, but the function expects a `object<Illuminate\Contra...Foundation\Application>`. 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...
50	142	$this->name = $name;
51	142	$this->path = realpath($path);
52	142	}
53
54		/**
55		* Get laravel instance.
56		*
57		* @return \Illuminate\Contracts\Foundation\Application\|Laravel\Lumen\Application
58		*/
59	1	public function getLaravel()
60		{
61	1	return $this->app;
62		}
63
64		/**
65		* Get name.
66		*
67		* @return string
68		*/
69	2	public function getName()
70		{
71	2	return $this->name;
72		}
73
74		/**
75		* Get name in lower case.
76		*
77		* @return string
78		*/
79	107	public function getLowerName()
80		{
81	107	return strtolower($this->name);
82		}
83
84		/**
85		* Get name in studly case.
86		*
87		* @return string
88		*/
89	93	public function getStudlyName()
90		{
91	93	return Str::studly($this->name);
92		}
93
94		/**
95		* Get name in snake case.
96		*
97		* @return string
98		*/
99	6	public function getSnakeName()
100		{
101	6	return Str::snake($this->name);
102		}
103
104		/**
105		* Get description.
106		*
107		* @return string
108		*/
109	2	public function getDescription()
110		{
111	2	return $this->get('description');
112		}
113
114		/**
115		* Get alias.
116		*
117		* @return string
118		*/
119	4	public function getAlias()
120		{
121	4	return $this->get('alias');
122		}
123
124		/**
125		* Get priority.
126		*
127		* @return string
128		*/
129		public function getPriority()
130		{
131		return $this->get('priority');
132		}
133
134		/**
135		* Get module requirements.
136		*
137		* @return array
138		*/
139	3	public function getRequires()
140		{
141	3	return $this->get('requires');
142		}
143
144		/**
145		* Get path.
146		*
147		* @return string
148		*/
149	126	public function getPath()
150		{
151	126	return $this->path;
152		}
153
154		/**
155		* Set path.
156		*
157		* @param string $path
158		*
159		* @return $this
160		*/
161		public function setPath($path)
162		{
163		$this->path = $path;
164
165		return $this;
166		}
167
168		/**
169		* Bootstrap the application events.
170		*/
171	2	public function boot()
172		{
173	2	if (config('modules.register.translations', true) === true) {
174	2	$this->registerTranslation();
175		}
176
177	2	if ($this->isLoadFilesOnBoot()) {
178		$this->registerFiles();
179		}
180
181	2	$this->fireEvent('boot');
182	2	}
183
184		/**
185		* Register module's translation.
186		*
187		* @return void
188		*/
189	2	protected function registerTranslation()
190		{
191	2	$lowerName = $this->getLowerName();
192
193	2	$langPath = $this->getPath() . '/Resources/lang';
194
195	2	if (is_dir($langPath)) {
196	2	$this->loadTranslationsFrom($langPath, $lowerName);
197		}
198	2	}
199
200		/**
201		* Get json contents from the cache, setting as needed.
202		*
203		* @param string $file
204		*
205		* @return Json
206		*/
207	34	public function json($file = null) : Json
208		{
209	34	if ($file === null) {
210	32	$file = 'module.json';
211		}
212
213	34	return array_get($this->moduleJson, $file, function () use ($file) {
214	34	return $this->moduleJson[$file] = new Json($this->getPath() . '/' . $file, $this->app['files']);
215	34	});
216		}
217
218		/**
219		* Get a specific data from json file by given the key.
220		*
221		* @param string $key
222		* @param null $default
223		*
224		* @return mixed
225		*/
226	24	public function get(string $key, $default = null)
227		{
228	24	return $this->json()->get($key, $default);
229		}
230
231		/**
232		* Get a specific data from composer.json file by given the key.
233		*
234		* @param $key
235		* @param null $default
236		*
237		* @return mixed
238		*/
239	2	public function getComposerAttr($key, $default = null)
240		{
241	2	return $this->json('composer.json')->get($key, $default);
242		}
243
244		/**
245		* Register the module.
246		*/
247		public function register()
248		{
249		$this->registerAliases();
250
251		$this->registerProviders();
252
253		if ($this->isLoadFilesOnBoot() === false) {
254		$this->registerFiles();
255		}
256
257		$this->fireEvent('register');
258		}
259
260		/**
261		* Register the module event.
262		*
263		* @param string $event
264		*/
265	8	protected function fireEvent($event)
266		{
267	8	$this->app['events']->fire(sprintf('modules.%s.' . $event, $this->getLowerName()), [$this]);
268	8	}
269		/**
270		* Register the aliases from this module.
271		*/
272		abstract public function registerAliases();
273
274		/**
275		* Register the service providers from this module.
276		*/
277		abstract public function registerProviders();
278
279		/**
280		* Get the path to the cached *_module.php file.
281		*
282		* @return string
283		*/
284		abstract public function getCachedServicesPath();
285
286		/**
287		* Register the files from this module.
288		*/
289		protected function registerFiles()
290		{
291		foreach ($this->get('files', []) as $file) {
292		include $this->path . '/' . $file;
293		}
294		}
295
296		/**
297		* Handle call __toString.
298		*
299		* @return string
300		*/
301	3	public function __toString()
302		{
303	3	return $this->getStudlyName();
304		}
305
306		/**
307		* Determine whether the given status same with the current module status.
308		*
309		* @param $status
310		*
311		* @return bool
312		*/
313	11	public function isStatus($status) : bool
314		{
315	11	return $this->get('active', 0) === $status;
316		}
317
318		/**
319		* Determine whether the current module activated.
320		*
321		* @return bool
322		*/
323	2	public function enabled() : bool
324		{
325	2	return $this->isStatus(1);
326		}
327
328		/**
329		* Alternate for "enabled" method.
330		*
331		* @return bool
332		* @deprecated
333		*/
334	6	public function active()
335		{
336	6	return $this->isStatus(1);
337		}
338
339		/**
340		* Determine whether the current module not activated.
341		*
342		* @return bool
343		* @deprecated
344		*/
345	2	public function notActive()
346		{
347	2	return !$this->active();
		0 ignored issues – show Deprecated Code introduced 2017-09-27 08:51 UTC by Report Bug Copy Issue Report The method `Nwidart\Modules\Module::active()` has been deprecated. This method has been deprecated. Loading history...
348		}
349
350		/**
351		* Determine whether the current module not disabled.
352		*
353		* @return bool
354		*/
355	2	public function disabled() : bool
356		{
357	2	return !$this->enabled();
358		}
359
360		/**
361		* Set active state for current module.
362		*
363		* @param $active
364		*
365		* @return bool
366		*/
367	6	public function setActive($active)
368		{
369	6	return $this->json()->set('active', $active)->save();
370		}
371
372		/**
373		* Disable the current module.
374		*/
375	3	public function disable()
376		{
377	3	$this->fireEvent('disabling');
378
379	3	$this->setActive(0);
380
381	3	$this->fireEvent('disabled');
382	3	}
383
384		/**
385		* Enable the current module.
386		*/
387	3	public function enable()
388		{
389	3	$this->fireEvent('enabling');
390
391	3	$this->setActive(1);
392
393	3	$this->fireEvent('enabled');
394	3	}
395
396		/**
397		* Delete the current module.
398		*
399		* @return bool
400		*/
401	2	public function delete()
402		{
403	2	return $this->json()->getFilesystem()->deleteDirectory($this->getPath());
404		}
405
406		/**
407		* Get extra path.
408		*
409		* @param string $path
410		*
411		* @return string
412		*/
413	3	public function getExtraPath(string $path) : string
414		{
415	3	return $this->getPath() . '/' . $path;
416		}
417
418		/**
419		* Handle call to __get method.
420		*
421		* @param $key
422		*
423		* @return mixed
424		*/
425		public function __get($key)
426		{
427		return $this->get($key);
428		}
429
430		/**
431		* Check if can load files of module on boot method.
432		*
433		* @return bool
434		*/
435	2	protected function isLoadFilesOnBoot()
436		{
437	2	return config('modules.register.files', 'register') === 'boot' &&
438		// force register method if option == boot && app is AsgardCms
439	2	!class_exists('\Modules\Core\Foundation\AsgardCms');
440		}
441		}
442

nWidart / laravel-modules

Pull Request — master (#445)

Module::isLoadFilesOnBoot() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like