LaravelDatabaseRepository::collections() - Code Metrics - Inspection of "Add database management feature" - nWidart/laravel-modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1163)

unknown

created 2021-01-07 10:23 UTC

LaravelDatabaseRepository::collections() A

↳ Parent: LaravelDatabaseRepository

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Nwidart\Modules\Laravel;

use Illuminate\Contracts\Filesystem\FileNotFoundException;
use Illuminate\Support\Facades\Schema;
use Illuminate\Support\Str;
use Nwidart\Modules\Collection;
use Nwidart\Modules\Contracts\ActivatorInterface;
use Nwidart\Modules\Contracts\DatabaseRepositoryInterface;
use Nwidart\Modules\Entities\ModuleEntity;
use Nwidart\Modules\Exceptions\ModuleNotFoundException;
use Nwidart\Modules\Generators\DatabaseModuleGenerator;
use Nwidart\Modules\Json;

class LaravelDatabaseRepository extends LaravelFileRepository implements DatabaseRepositoryInterface
{
    /**
     * Creates a new Module instance.
     *
     * @param mixed ...$args
     *
     * @return DatabaseModule
     */
    protected function createModule(...$args)
    {
        return new DatabaseModule(...$args);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @return ModuleEntity
     */
    public function getModel()
    {
        return new ModuleEntity();
    }

    /**
     * Scan & get all available modules.
     */
    public function scan()
    {
        /**
         * @var ModuleEntity[] $rows
         */
        $rows = $this->getModel()->get();
        $modules = [];
        if (!empty($rows)) {
            foreach ($rows as $row) {
                if (file_exists($row->path)) {
                    $modules[$row->name] = $this->createModule($this->app, $row->name, $row->path);
                }
            }
        }

        return $modules;
    }

    /**
     * Determine whether the given module exist.
     *
     * @param $name
     *
     * @return bool
     */
    public function has($name): bool
    {
        return $this->getModel()->where('name', $name)->exists();
    }

    /**
     * @inheritDoc
     */
    public function find(string $name)
    {
        /** @var ModuleEntity $module */
        $module = $this->getModel()->where('name', $name)->first();
        if (!$module) {
            return null;
        }
        if (!file_exists($module->path)) {
            return null;
        }

        return $this->createModule($this->app, $module->name, $module->path);
    }

    /**
     * Get all modules as laravel collection instance.
     *
     * @param $status
     *
     * @return Collection
     */
    public function collections($status = 1): Collection
    {
        return new Collection($this->getByStatus($status));
    }

    /**
     * Get module path for a specific module.
     *
     * @param $name
     *
     * @return string
     */
    public function getModulePath($name)
    {
        $module = $this->find($name);
        if ($module) {
            return $module->getPath() . '/';
        }

        return $this->getPath() . '/' . Str::studly($name) . '/';
    }

    /**
     * Get modules by status.
     *
     * @param $status
     *
     * @return array
     */
    public function getByStatus($status): array
    {
        $modules = [];

        foreach ($this->all() as $name => $module) {
            if ($module->isStatus($status) == $status) {
                $modules[$name] = $module;
            }
        }

        return $modules;
    }

    /**
     * Format the cached data as array of modules.
     *
     * @param array $cached
     *
     * @return array
     */
    protected function formatCached($cached)
    {
        $modules = [];

        foreach ($cached as $moduleEntity) {
            $module = $this->createModule($this->app, $moduleEntity['name'], $moduleEntity['path']);
            $module->setAttributes($moduleEntity->toArray());
            $modules[$moduleEntity['name']] = $module;
        }

        return $modules;
    }

    /**
     * Get cached modules from database.
     *
     * @return ModuleEntity[]
     */
    public function getCached()
    {
        return $this->app['cache']->remember($this->config('cache.key'), $this->config('cache.lifetime'), function () {
            return $this->getModel()->all();
        });
    }

    public function all(): array
    {
        // Do not load or register if there are no modules table yet.
        if (!Schema::hasTable('modules')) {
            return [];
        }

        return parent::all();
    }

    public function create($params, $force = true, $isApi = true, $isPlain = true)
    {
        $moduleType = $this->getModuleType($isApi, $isPlain); // Custom later.
        /** @var DatabaseModuleGenerator $generator */
        $generator = with(new DatabaseModuleGenerator($params['name']));
        $code = $generator
            ->setFilesystem(app('files'))
            ->setModule($this)
            ->setConfig(app('config'))
            ->setActivator(app(ActivatorInterface::class))
            ->setForce($force)
            ->setType($moduleType)
            ->setActive($params['is_active'])
            ->setSilentOutput(true) // Don't use console output
            ->generate();

        return $code ? $this->find($params['name']) : false;
    }

    /**
     * Get module type .
     *
     * @param bool $isApi
     * @param bool $isPlain
     *
     * @return string
     */
    public function getModuleType($isApi = true, $isPlain = true)
    {
        if ($isPlain && $isApi) {
            return 'web';
        }
        if ($isPlain) {
            return 'plain';
        } elseif ($isApi) {
            return 'api';
        } else {
            return 'web';
        }
    }

    /**
     * Get module used for cli session.
     * @return string
     * @throws ModuleNotFoundException|FileNotFoundException
     */
    public function getUsedNow(): string
    {
        $module = $this->getFiles()->get($this->getUsedStoragePath());
        if (!$module) {
            return '';
        }

        return $this->findOrFail($module);
    }

    public function migrateFileToDatabase()
    {
        $paths = $this->getScanPaths();
        $modules = [];

        foreach ($paths as $key => $path) {
            $manifests = $this->getFiles()->glob("{$path}/module.json");

            is_array($manifests) || $manifests = [];

            foreach ($manifests as $manifest) {
                $json = Json::make($manifest);
                $data = $json->getAttributes();
                $data['path'] = str_replace('module.json', '', $json->getPath());
                if (!isset($data['version'])) {
                    $data['version'] = '1.0.0';
                }
                $module = $this->find($data['name']);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
                if (!$module) {
                    $modules[] = $this->getModel()->create($data);
                } else {
                    // Check version, if version is higher then update module.json into database.
                    if (version_compare($module->getVersion(), $data['version'], '<')) {
                        $modules[] = $this->getModel()->where(['name' => $data['name']])->update($data);
                    }
                }
            }
        }

        return $modules;
    }

}


1		<?php
2
3		namespace Nwidart\Modules\Laravel;
4
5		use Illuminate\Contracts\Filesystem\FileNotFoundException;
6		use Illuminate\Support\Facades\Schema;
7		use Illuminate\Support\Str;
8		use Nwidart\Modules\Collection;
9		use Nwidart\Modules\Contracts\ActivatorInterface;
10		use Nwidart\Modules\Contracts\DatabaseRepositoryInterface;
11		use Nwidart\Modules\Entities\ModuleEntity;
12		use Nwidart\Modules\Exceptions\ModuleNotFoundException;
13		use Nwidart\Modules\Generators\DatabaseModuleGenerator;
14		use Nwidart\Modules\Json;
15
16		class LaravelDatabaseRepository extends LaravelFileRepository implements DatabaseRepositoryInterface
17		{
18		/**
19		* Creates a new Module instance.
20		*
21		* @param mixed ...$args
22		*
23		* @return DatabaseModule
24		*/
25		protected function createModule(...$args)
26		{
27		return new DatabaseModule(...$args);
		0 ignored issues – show Bug introduced 2021-01-06 04:27 UTC by Report Bug Copy Issue Report The call to `DatabaseModule::__construct()` misses some required arguments starting with `$name`. Loading history... Documentation introduced 2021-01-06 07:38 UTC by Report Bug Copy Issue Report `$args` is of type `array<integer,*>`, but the function expects a `object<Illuminate\Container\Container>`. 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...
28		}
29
30		/**
31		* @return ModuleEntity
32		*/
33		public function getModel()
34		{
35		return new ModuleEntity();
36		}
37
38		/**
39		* Scan & get all available modules.
40		*/
41		public function scan()
42		{
43		/**
44		* @var ModuleEntity[] $rows
45		*/
46		$rows = $this->getModel()->get();
47		$modules = [];
48		if (!empty($rows)) {
49		foreach ($rows as $row) {
50		if (file_exists($row->path)) {
51		$modules[$row->name] = $this->createModule($this->app, $row->name, $row->path);
52		}
53		}
54		}
55
56		return $modules;
57		}
58
59		/**
60		* Determine whether the given module exist.
61		*
62		* @param $name
63		*
64		* @return bool
65		*/
66		public function has($name): bool
67		{
68		return $this->getModel()->where('name', $name)->exists();
69		}
70
71		/**
72		* @inheritDoc
73		*/
74		public function find(string $name)
75		{
76		/** @var ModuleEntity $module */
77		$module = $this->getModel()->where('name', $name)->first();
78		if (!$module) {
79		return null;
80		}
81		if (!file_exists($module->path)) {
82		return null;
83		}
84
85		return $this->createModule($this->app, $module->name, $module->path);
86		}
87
88		/**
89		* Get all modules as laravel collection instance.
90		*
91		* @param $status
92		*
93		* @return Collection
94		*/
95		public function collections($status = 1): Collection
96		{
97		return new Collection($this->getByStatus($status));
98		}
99
100		/**
101		* Get module path for a specific module.
102		*
103		* @param $name
104		*
105		* @return string
106		*/
107		public function getModulePath($name)
108		{
109		$module = $this->find($name);
110		if ($module) {
111		return $module->getPath() . '/';
112		}
113
114		return $this->getPath() . '/' . Str::studly($name) . '/';
115		}
116
117		/**
118		* Get modules by status.
119		*
120		* @param $status
121		*
122		* @return array
123		*/
124	View Code Duplication	public function getByStatus($status): array
125		{
126		$modules = [];
127
128		foreach ($this->all() as $name => $module) {
129		if ($module->isStatus($status) == $status) {
130		$modules[$name] = $module;
131		}
132		}
133
134		return $modules;
135		}
136
137		/**
138		* Format the cached data as array of modules.
139		*
140		* @param array $cached
141		*
142		* @return array
143		*/
144		protected function formatCached($cached)
145		{
146		$modules = [];
147
148		foreach ($cached as $moduleEntity) {
149		$module = $this->createModule($this->app, $moduleEntity['name'], $moduleEntity['path']);
150		$module->setAttributes($moduleEntity->toArray());
151		$modules[$moduleEntity['name']] = $module;
152		}
153
154		return $modules;
155		}
156
157		/**
158		* Get cached modules from database.
159		*
160		* @return ModuleEntity[]
161		*/
162		public function getCached()
163		{
164		return $this->app['cache']->remember($this->config('cache.key'), $this->config('cache.lifetime'), function () {
165		return $this->getModel()->all();
166		});
167		}
168
169		public function all(): array
170		{
171		// Do not load or register if there are no modules table yet.
172		if (!Schema::hasTable('modules')) {
173		return [];
174		}
175
176		return parent::all();
177		}
178
179		public function create($params, $force = true, $isApi = true, $isPlain = true)
180		{
181		$moduleType = $this->getModuleType($isApi, $isPlain); // Custom later.
182		/** @var DatabaseModuleGenerator $generator */
183		$generator = with(new DatabaseModuleGenerator($params['name']));
184		$code = $generator
185		->setFilesystem(app('files'))
186		->setModule($this)
187		->setConfig(app('config'))
188		->setActivator(app(ActivatorInterface::class))
189		->setForce($force)
190		->setType($moduleType)
191		->setActive($params['is_active'])
192		->setSilentOutput(true) // Don't use console output
193		->generate();
194
195		return $code ? $this->find($params['name']) : false;
196		}
197
198		/**
199		* Get module type .
200		*
201		* @param bool $isApi
202		* @param bool $isPlain
203		*
204		* @return string
205		*/
206		public function getModuleType($isApi = true, $isPlain = true)
207		{
208		if ($isPlain && $isApi) {
209		return 'web';
210		}
211		if ($isPlain) {
212		return 'plain';
213		} elseif ($isApi) {
214		return 'api';
215		} else {
216		return 'web';
217		}
218		}
219
220		/**
221		* Get module used for cli session.
222		* @return string
223		* @throws ModuleNotFoundException\|FileNotFoundException
224		*/
225		public function getUsedNow(): string
226		{
227		$module = $this->getFiles()->get($this->getUsedStoragePath());
228		if (!$module) {
229		return '';
230		}
231
232		return $this->findOrFail($module);
233		}
234
235		public function migrateFileToDatabase()
236		{
237		$paths = $this->getScanPaths();
238		$modules = [];
239
240		foreach ($paths as $key => $path) {
241		$manifests = $this->getFiles()->glob("{$path}/module.json");
242
243		is_array($manifests) \|\| $manifests = [];
244
245		foreach ($manifests as $manifest) {
246		$json = Json::make($manifest);
247		$data = $json->getAttributes();
248		$data['path'] = str_replace('module.json', '', $json->getPath());
249		if (!isset($data['version'])) {
250		$data['version'] = '1.0.0';
251		}
252		$module = $this->find($data['name']);
		0 ignored issues – show Bug introduced 2021-01-07 10:26 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$module` is correct as `$this->find($data['name'])` (which targets `Nwidart\Modules\Laravel\...abaseRepository::find()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
253		if (!$module) {
254		$modules[] = $this->getModel()->create($data);
255		} else {
256		// Check version, if version is higher then update module.json into database.
257		if (version_compare($module->getVersion(), $data['version'], '<')) {
258		$modules[] = $this->getModel()->where(['name' => $data['name']])->update($data);
259		}
260		}
261		}
262		}
263
264		return $modules;
265		}
266
267		}
268

nWidart / laravel-modules

Pull Request — master (#1163)

LaravelDatabaseRepository::collections() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like