Modules::getMaintenance() - Code Metrics - Inspection of "Call a one off method when a module is enabled or..." - caffeinated/modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#192)

unknown

created 2016-05-30 19:19 UTC

Modules::getMaintenance() A

↳ Parent: Modules

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Caffeinated\Modules;

use Caffeinated\Modules\Contracts\RepositoryInterface;
use Illuminate\Foundation\Application;

class Modules implements RepositoryInterface
{
    /**
     * @var Application
     */
    protected $app;

    /**
     * @var RepositoryInterface
     */
    protected $repository;

    /**
     * Create a new Modules instance.
     *
     * @param Application         $app
     * @param RepositoryInterface $repository
     */
    public function __construct(Application $app, RepositoryInterface $repository)
    {
        $this->app = $app;
        $this->repository = $repository;
    }

    /**
     * Register the module service provider file from all modules.
     *
     * @return mixed
     */
    public function register()
    {
        $modules = $this->repository->enabled();

        $modules->each(function ($properties, $slug) {

            $this->registerServiceProvider($properties);

            $this->autoloadFiles($properties);
        });
    }

    /**
     * Register the module service provider.
     *
     * @param string $properties
     *
     * @return string
     *
     * @throws \Caffeinated\Modules\Exception\FileMissingException
     */
    protected function registerServiceProvider($properties)
    {
        $namespace = $this->resolveNamespace($properties);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $file = $this->repository->getPath()."/{$namespace}/Providers/{$namespace}ServiceProvider.php";
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $serviceProvider = $this->repository->getNamespace().'\\'.$namespace."\\Providers\\{$namespace}ServiceProvider";

        if (class_exists($serviceProvider)) {
            $this->app->register($serviceProvider);
        }
    }

    /**
     * Autoload custom module files.
     *
     * @param array $properties
     */
    protected function autoloadFiles($properties)
    {
        if (isset($properties['autoload'])) {
            $namespace = $this->resolveNamespace($properties);
            $path = $this->repository->getPath()."/{$namespace}/";

            foreach ($properties['autoload'] as $file) {
                include $path.$file;
            }
        }
    }

    public function optimize()
    {
        return $this->repository->optimize();
    }

    /**
     * Get all modules.
     *
     * @return Collection
     */
    public function all()
    {
        return $this->repository->all();
    }

    /**
     * Get all module slugs.
     *
     * @return array
     */
    public function slugs()
    {
        return $this->repository->slugs();
    }

    /**
     * Get modules based on where clause.
     *
     * @param string $key
     * @param mixed  $value
     *
     * @return Collection
     */
    public function where($key, $value)
    {
        return $this->repository->where($key, $value);
    }

    /**
     * Sort modules by given key in ascending order.
     *
     * @param string $key
     *
     * @return Collection
     */
    public function sortBy($key)
    {
        return $this->repository->sortBy($key);
    }

    /**
     * Sort modules by given key in ascending order.
     *
     * @param string $key
     *
     * @return Collection
     */
    public function sortByDesc($key)
    {
        return $this->repository->sortByDesc($key);
    }

    /**
     * Check if the given module exists.
     *
     * @param string $slug
     *
     * @return bool
     */
    public function exists($slug)
    {
        return $this->repository->exists($slug);
    }

    /**
     * Returns count of all modules.
     *
     * @return int
     */
    public function count()
    {
        return $this->repository->count();
    }

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

    /**
     * Set modules path in "RunTime" mode.
     *
     * @param string $path
     *
     * @return object $this
     */
    public function setPath($path)
    {
        return $this->repository->setPath($path);
    }

    /**
     * Get path for the specified module.
     *
     * @param string $slug
     *
     * @return string
     */
    public function getModulePath($slug)
    {
        return $this->repository->getModulePath($slug);
    }

    /**
     * Get modules namespace.
     *
     * @return string
     */
    public function getNamespace()
    {
        return $this->repository->getNamespace();
    }

    /**
     * Get a module's properties.
     *
     * @param string $slug
     *
     * @return mixed
     */
    public function getManifest($slug)
    {
        return $this->repository->getManifest($slug);
    }

    /**
     * Get a module property value.
     *
     * @param string $property
     * @param mixed  $default
     *
     * @return mixed
     */
    public function get($property, $default = null)
    {
        return $this->repository->get($property, $default);
    }

    /**
     * Set a module property value.
     *
     * @param string $property
     * @param mixed  $value
     *
     * @return bool
     */
    public function set($property, $value)
    {
        return $this->repository->set($property, $value);
    }

    /**
     * Gets all enabled modules.
     *
     * @return array
     */
    public function enabled()
    {
        return $this->repository->enabled();
    }

    /**
     * Gets all disabled modules.
     *
     * @return array
     */
    public function disabled()
    {
        return $this->repository->disabled();
    }

    /**
     * Check if specified module is enabled.
     *
     * @param string $slug
     *
     * @return bool
     */
    public function isEnabled($slug)
    {
        return $this->repository->isEnabled($slug);
    }

    /**
     * Check if specified module is disabled.
     *
     * @param string $slug
     *
     * @return bool
     */
    public function isDisabled($slug)
    {
        return $this->repository->isDisabled($slug);
    }

    /**
     * Enables the specified module.
     *
     * @param string $slug
     *
     * @return bool
     */
    public function enable($slug)
    {
        // Resolve and invoke the modules own initialize method.
        // Thanks to sroutier/l51esk-modules
        $maintenanceInstance = $this->getMaintenance($slug);
        $maintenanceInstance::enable();

        return $this->repository->enable($slug);
    }

    /**
     * Disables the specified module.
     *
     * @param string $slug
     *
     * @return bool
     */
    public function disable($slug)
    {
        // Resolve and invoke the modules own initialize method.
        // Thanks to sroutier/l51esk-modules
        $maintenanceInstance = $this->getMaintenance($slug);
        $maintenanceInstance::disable();

        return $this->repository->disable($slug);
    }

    /**
     * Resolve the correct module namespace.
     *
     * @param array $properties
     */
    private function resolveNamespace($properties)
    {
        return isset($properties['namespace'])
            ? $properties['namespace']
            : studly_case($properties['slug'])
        ;
    }

    /**
     * Resolve and instantiate the module's maintenance class.
     * Thanks to sroutier/l51esk-modules
     *
     * @param $slug
     * @return object
     */
    public function getMaintenance($slug)
    {
        $maintenanceInstance = null;
        $nameSpace = \Module::where('slug', $slug)->first()['namespace'];
        $maintenanceFile  =        config('modules.path')      . '/' . $nameSpace . '/Utils/'   . $nameSpace . 'Maintenance.php';
        $maintenanceClass = '\\' . config('modules.namespace') .       $nameSpace . '\\Utils\\' . $nameSpace . 'Maintenance';
        require($maintenanceFile);
        $maintenanceInstance = new $maintenanceClass();
        return $maintenanceInstance;
    }
}


1		<?php
2
3		namespace Caffeinated\Modules;
4
5		use Caffeinated\Modules\Contracts\RepositoryInterface;
6		use Illuminate\Foundation\Application;
7
8		class Modules implements RepositoryInterface
9		{
10		/**
11		* @var Application
12		*/
13		protected $app;
14
15		/**
16		* @var RepositoryInterface
17		*/
18		protected $repository;
19
20		/**
21		* Create a new Modules instance.
22		*
23		* @param Application $app
24	1	* @param RepositoryInterface $repository
25		*/
26	1	public function __construct(Application $app, RepositoryInterface $repository)
27	1	{
28	1	$this->app = $app;
29		$this->repository = $repository;
30		}
31
32		/**
33		* Register the module service provider file from all modules.
34		*
35		* @return mixed
36		*/
37		public function register()
38		{
39		$modules = $this->repository->enabled();
40
41		$modules->each(function ($properties, $slug) {
		0 ignored issues – show Unused Code introduced 2015-12-03 18:30 UTC by Report Bug Copy Issue Report The parameter `$slug` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
42		$this->registerServiceProvider($properties);
43
44		$this->autoloadFiles($properties);
45		});
46		}
47
48		/**
49		* Register the module service provider.
50		*
51		* @param string $properties
52		*
53		* @return string
54		*
55		* @throws \Caffeinated\Modules\Exception\FileMissingException
56		*/
57		protected function registerServiceProvider($properties)
58		{
59		$namespace = $this->resolveNamespace($properties);
		0 ignored issues – show Documentation introduced 2015-12-26 04:59 UTC by Report Bug Copy Issue Report `$properties` is of type `string`, but the function expects a `array`. 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...
60		$file = $this->repository->getPath()."/{$namespace}/Providers/{$namespace}ServiceProvider.php";
		0 ignored issues – show Unused Code introduced 2015-12-26 04:59 UTC by Report Bug Copy Issue Report `$file` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
61		$serviceProvider = $this->repository->getNamespace().'\\'.$namespace."\\Providers\\{$namespace}ServiceProvider";
62
63		if (class_exists($serviceProvider)) {
64		$this->app->register($serviceProvider);
65		}
66		}
67
68		/**
69		* Autoload custom module files.
70		*
71		* @param array $properties
72		*/
73		protected function autoloadFiles($properties)
74		{
75		if (isset($properties['autoload'])) {
76		$namespace = $this->resolveNamespace($properties);
77		$path = $this->repository->getPath()."/{$namespace}/";
78
79		foreach ($properties['autoload'] as $file) {
80		include $path.$file;
81		}
82		}
83		}
84
85		public function optimize()
86		{
87		return $this->repository->optimize();
88		}
89
90		/**
91		* Get all modules.
92		*
93		* @return Collection
94		*/
95		public function all()
96		{
97		return $this->repository->all();
98		}
99
100		/**
101		* Get all module slugs.
102		*
103		* @return array
104		*/
105		public function slugs()
106		{
107		return $this->repository->slugs();
108		}
109
110		/**
111		* Get modules based on where clause.
112		*
113		* @param string $key
114		* @param mixed $value
115		*
116		* @return Collection
117		*/
118		public function where($key, $value)
119		{
120		return $this->repository->where($key, $value);
121		}
122
123		/**
124		* Sort modules by given key in ascending order.
125		*
126		* @param string $key
127		*
128		* @return Collection
129		*/
130		public function sortBy($key)
131		{
132		return $this->repository->sortBy($key);
133		}
134
135		/**
136		* Sort modules by given key in ascending order.
137		*
138		* @param string $key
139		*
140		* @return Collection
141		*/
142		public function sortByDesc($key)
143		{
144		return $this->repository->sortByDesc($key);
145		}
146
147		/**
148		* Check if the given module exists.
149		*
150		* @param string $slug
151		*
152		* @return bool
153		*/
154		public function exists($slug)
155		{
156		return $this->repository->exists($slug);
157		}
158
159		/**
160		* Returns count of all modules.
161		*
162		* @return int
163		*/
164		public function count()
165		{
166		return $this->repository->count();
167		}
168
169		/**
170		* Get modules path.
171		*
172		* @return string
173		*/
174		public function getPath()
175		{
176		return $this->repository->getPath();
177		}
178
179		/**
180		* Set modules path in "RunTime" mode.
181		*
182		* @param string $path
183		*
184		* @return object $this
185		*/
186		public function setPath($path)
187		{
188		return $this->repository->setPath($path);
189		}
190
191		/**
192		* Get path for the specified module.
193		*
194		* @param string $slug
195		*
196		* @return string
197		*/
198		public function getModulePath($slug)
199		{
200		return $this->repository->getModulePath($slug);
201		}
202
203		/**
204		* Get modules namespace.
205		*
206		* @return string
207		*/
208		public function getNamespace()
209		{
210		return $this->repository->getNamespace();
211		}
212
213		/**
214		* Get a module's properties.
215		*
216		* @param string $slug
217		*
218		* @return mixed
219		*/
220		public function getManifest($slug)
221		{
222		return $this->repository->getManifest($slug);
223		}
224
225		/**
226		* Get a module property value.
227		*
228		* @param string $property
229		* @param mixed $default
230		*
231		* @return mixed
232		*/
233		public function get($property, $default = null)
234		{
235		return $this->repository->get($property, $default);
236		}
237
238		/**
239		* Set a module property value.
240		*
241		* @param string $property
242		* @param mixed $value
243		*
244		* @return bool
245		*/
246		public function set($property, $value)
247		{
248		return $this->repository->set($property, $value);
249		}
250
251		/**
252		* Gets all enabled modules.
253		*
254		* @return array
255		*/
256		public function enabled()
257		{
258		return $this->repository->enabled();
259		}
260
261		/**
262		* Gets all disabled modules.
263		*
264		* @return array
265		*/
266		public function disabled()
267		{
268		return $this->repository->disabled();
269		}
270
271		/**
272		* Check if specified module is enabled.
273		*
274		* @param string $slug
275		*
276		* @return bool
277		*/
278		public function isEnabled($slug)
279		{
280		return $this->repository->isEnabled($slug);
281		}
282
283		/**
284		* Check if specified module is disabled.
285		*
286		* @param string $slug
287		*
288		* @return bool
289		*/
290		public function isDisabled($slug)
291		{
292		return $this->repository->isDisabled($slug);
293		}
294
295		/**
296		* Enables the specified module.
297		*
298		* @param string $slug
299		*
300		* @return bool
301		*/
302		public function enable($slug)
303		{
304		// Resolve and invoke the modules own initialize method.
305		// Thanks to sroutier/l51esk-modules
306		$maintenanceInstance = $this->getMaintenance($slug);
307		$maintenanceInstance::enable();
308
309		return $this->repository->enable($slug);
310		}
311
312		/**
313		* Disables the specified module.
314		*
315		* @param string $slug
316		*
317		* @return bool
318		*/
319		public function disable($slug)
320		{
321		// Resolve and invoke the modules own initialize method.
322		// Thanks to sroutier/l51esk-modules
323		$maintenanceInstance = $this->getMaintenance($slug);
324		$maintenanceInstance::disable();
325
326		return $this->repository->disable($slug);
327		}
328
329		/**
330		* Resolve the correct module namespace.
331		*
332		* @param array $properties
333		*/
334		private function resolveNamespace($properties)
335		{
336		return isset($properties['namespace'])
337		? $properties['namespace']
338		: studly_case($properties['slug'])
339		;
340		}
341
342		/**
343		* Resolve and instantiate the module's maintenance class.
344		* Thanks to sroutier/l51esk-modules
345		*
346		* @param $slug
347		* @return object
348		*/
349		public function getMaintenance($slug)
350		{
351		$maintenanceInstance = null;
352		$nameSpace = \Module::where('slug', $slug)->first()['namespace'];
353		$maintenanceFile = config('modules.path') . '/' . $nameSpace . '/Utils/' . $nameSpace . 'Maintenance.php';
354		$maintenanceClass = '\\' . config('modules.namespace') . $nameSpace . '\\Utils\\' . $nameSpace . 'Maintenance';
355		require($maintenanceFile);
356		$maintenanceInstance = new $maintenanceClass();
357		return $maintenanceInstance;
358		}
359		}
360

caffeinated / modules

GitHub Access Token became invalid

Pull Request — master (#192)

Modules::getMaintenance() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like