Nwidart\Modules\Laravel\DatabaseModule

Complexity

Total Complexity

18

Size/Duplication

Total Lines	168
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getModel()	0	4	1
A	getAttributes()	0	4	1
A	setAttributes()	0	4	1
A	get()	0	4	2
A	isStatus()	0	4	1
A	isEnabled()	0	4	1
A	isDisabled()	0	4	1
A	setActive()	0	5	1
A	disable()	0	8	1
A	enable()	0	8	1
A	delete()	0	10	2
A	getVersion()	0	4	1
A	update()	0	23	4

<?php

namespace Nwidart\Modules\Laravel;

use Exception;
use Illuminate\Filesystem\Filesystem;
use Nwidart\Modules\Entities\ModuleEntity;
use Nwidart\Modules\Json;
use Nwidart\Modules\Process\Updater;

class DatabaseModule extends Module
{
    /**
     * @var array<string, mixed>
     */
    public $attributes;

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

    /**
     * Get attributes.
     *
     * @return array
     */
    public function getAttributes()
    {
        return $this->attributes;
    }

    /**
     * Set attributes.
     *
     * @param array $attributes
     */
    public function setAttributes($attributes)
    {
        $this->attributes = $attributes;
    }

    /**
     * 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 isset($this->attributes[$key]) ? $this->attributes[$key] : $default;
    }

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

    /**
     * Determine whether the current module activated.
     *
     * @return bool
     */
    public function isEnabled(): bool
    {
        return $this->attributes['is_active'];
    }

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

    /**
     * Set active state for current module.
     *
     * @param bool $active
     *
     * @return void
     */
    public function setActive(bool $active): void
    {
        $this->getModel()->where(['name' => $this->getName()])->update(['is_active' => $active]);
        $this->flushCache();
    }

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

        $this->setActive(false);

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

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

        $this->setActive(true);

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

    /**
     * Delete the current module.
     *
     * @return bool
     * @throws Exception
     */
    public function delete(): bool
    {
        $module = $this->getModel()->where(['name' => $this->getName()])->first();
        if ($module) {
            $module->delete();
        }
        $this->flushCache();

        return (new Filesystem())->deleteDirectory($this->getPath());
    }

    /**
     * Get version.
     *
     * @return mixed|null
     */
    public function getVersion()
    {
        return $this->get('version', '1.0.0');
    }

    public function update(Updater $updater)
    {

        if (config('modules.database_management.update_file_to_database_when_updating')) {
            $json = Json::make($this->getPath() . '/' . 'module.json');
            $data = $json->getAttributes();

            if (!isset($data['version'])) {
                $data['version'] = '1.0.0';
            }

            // Check version, if version is higher then update module.json into database.
            if (version_compare($this->getVersion(), $data['version'], '<=')) {
                $data = $updater->getModule()->validateAttributes($data);

It seems like you code against a concrete implementation and not the interface Nwidart\Modules\Contracts\RepositoryInterface as the method validateAttributes() does only exist in the following implementations of said interface: Nwidart\Modules\Laravel\LaravelDatabaseRepository.

                $this->getModel()->where(['name' => $data['name']])->update($data);
            }
        }

        $response = with($updater)->update($this->getName());
        $this->flushCache();

        return $response;
    }
}