Modules::getActionButtons() - Code Metrics - Inspection of "Puesta en orden y preparación para iniciar el Crud..." - rsanjoseo/alxarafe - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Push — main ( f24735...83b0dc )

by Rafael
created 2023-02-26 11:16 UTC
Modules::getActionButtons() A

↳ Parent: Modules
Complexity

Conditions	1
Paths	1
Size

Total Lines	22
Code Lines	16
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
cc	1
eloc	16
nc	1
nop	1
dl	0
loc	22
rs	9.7333
c	0
b	0
f	0
ccs	0
cts	0
cp	0
crap	2
<?php
/**
 * Copyright (C) 2022-2023  Rafael San José Tovar   <[email protected]>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

namespace Alxarafe\Controllers;

use Alxarafe\Core\Base\Controller;
use Alxarafe\Core\Base\View;
use Alxarafe\Core\Helpers\FormatUtils;
filter:
    dependency_paths: ["lib/*"]
use Alxarafe\Core\Helpers\Utils\FileSystemUtils;
filter:
    dependency_paths: ["lib/*"]
use Alxarafe\Core\Models\Module;
filter:
    dependency_paths: ["lib/*"]
use Alxarafe\Core\Providers\FlashMessages;
filter:
    dependency_paths: ["lib/*"]
use Alxarafe\Core\Providers\ModuleManager;
filter:
    dependency_paths: ["lib/*"]
use Alxarafe\Views\ModulesView;
use Symfony\Component\Finder\Finder;
use Symfony\Component\HttpFoundation\Response;

/**
 * Class Init
 *
 *
 *
 * @author  Rafael San José Tovar <[email protected]>
 * @version 08 2021
 *
 * @package Modules\Main
 */
class Modules extends Controller
{
    /**
     * Modules folder were are stored.
     *
     * @var string
     */
    private $modulesFolder;

    /**
     * @var array
     */
    private $modulesList = [];

    /**
     * Modules constructor.
     */
    public function __construct()
    {
        parent::__construct(new Module());
                __construct(new Module());
        $this->modulesFolder = basePath('src' . constant('DIRECTORY_SEPARATOR') . 'Modules');
        $this->modulesFolder = /** @scrutinizer ignore-call */ basePath('src' . constant('DIRECTORY_SEPARATOR') . 'Modules');
    }

    /**
     * The start point of the controller.
     *
     * @return Response
     */
    public function indexMethod(): Response
    {
        $this->modulesList = $this->getAvailableModules();
        $this->updateModulesData();

        return parent::indexMethod();
        return parent::/** @scrutinizer ignore-call */ indexMethod();
    }

    /**
     * Returns a list of availabe modules.
     *
     * @return array
     */
    private function getAvailableModules(): array
    {
        $modules = Finder::create()
            ->directories()
            ->depth(0)
            ->in($this->modulesFolder)
            ->sortByName();
        $modulesList = [];
        foreach ($modules as $module) {
            $modulesList[$module->getFileName()] = str_replace(basePath(DIRECTORY_SEPARATOR), '', $module->getPathName());
            $modulesList[$module->getFileName()] = str_replace(/** @scrutinizer ignore-call */ basePath(DIRECTORY_SEPARATOR), '', $module->getPathName());
        }
        return $modulesList;
    }

    /**
     * Updated all modules to database.
     */
    private function updateModulesData(): void
    {
        foreach ($this->modulesList as $name => $path) {
            $module = new Module();
            if (!$module->getBy('name', $name)) {
                $module->name = $name;
                $module->path = $path;
                $module->updated_date = FormatUtils::getFormatted(FormatUtils::getFormatDateTime());
                $module->save();
            }
        }
    }

    /**
     * Default create method for new registers.
     *
     * @return Response
     */
    public function createMethod(): Response
    {
        // TODO: Implement createMethod() method.
        // Require allow to submit a file
        return parent::createMethod();
        return parent::/** @scrutinizer ignore-call */ createMethod();
    }

    /**
     * Default read method for new registers.
     *
     * @return Response
     */
    public function readMethod(): Response
    {
        // TODO: Implement readMethod() method.
        // The data can be showed from table.
        return parent::readMethod();
        return parent::/** @scrutinizer ignore-call */ readMethod();
    }

    /**
     * Default update method for update an individual register.
     *
     * @return Response
     */
    public function updateMethod(): Response
    {
        // TODO: Implement updateMethod() method.
        // The data must be updated from each module.
        return parent::updateMethod();
        return parent::/** @scrutinizer ignore-call */ updateMethod();
    }

    /**
     * Default delete method for delete an individual register.
     *
     * @return Response
     */
    public function deleteMethod(): Response
    {
        if (!$this->canAccess || !$this->canDelete) {

            $this->renderer->setTemplate('master/noaccess');

            return $this->sendResponseTemplate();
            return $this->/** @scrutinizer ignore-call */ sendResponseTemplate();
        }
        $id = $this->request->query->get($this->model->getIdField());

        $this->model = new Module();

        if ($this->model->load($id)) {
            $this->model->enabled = 0;
            if ($this->model->save()) {
                FlashMessages::getInstance()::setSuccess(
                    $this->translator->trans('module-disabled', ['%moduleName%' => $this->model->{$this->model->getNameField()}])

                );
            }
        }

        FileSystemUtils::rrmdir(basePath($this->model->path));
        FileSystemUtils::rrmdir(/** @scrutinizer ignore-call */ basePath($this->model->path));
        return parent::deleteMethod();
        return parent::/** @scrutinizer ignore-call */ deleteMethod();
    }

    /**
     * Default enable method for enable an individual register.
     *
     * @return Response
     */
    public function enableMethod(): Response
    {
        if (!$this->canAccess || !$this->canUpdate) {

            $this->renderer->setTemplate('master/noaccess');

            return $this->sendResponseTemplate();
        }
        $id = $this->request->query->get($this->model->getIdField());

        $this->model = new Module();

        if ($this->model->load($id)) {
            $modelName = $this->model->{$this->model->getNameField()};
            ModuleManager::getInstance()::enableModule($modelName);
        }

        return $this->redirect(baseUrl('index.php?' . constant('CALL_CONTROLLER') . '=' . $this->shortName));
        return $this->redirect(/** @scrutinizer ignore-call */ baseUrl('index.php?' . constant('CALL_CONTROLLER') . '=' . $this->shortName));
    }

    /**
     * Default disable method for disable an individual register.
     *
     * @return Response
     */
    public function disableMethod(): Response
    {
        if (!$this->canAccess || !$this->canUpdate) {

            $this->renderer->setTemplate('master/noaccess');

            return $this->sendResponseTemplate();
        }
        $id = $this->request->query->get($this->model->getIdField());

        $this->model = new Module();

        if ($this->model->load($id)) {
            $modelName = $this->model->{$this->model->getNameField()};
            ModuleManager::getInstance()::disableModule($modelName);
        }

        return $this->redirect(baseUrl('index.php?' . constant('CALL_CONTROLLER') . '=' . $this->shortName));
        return $this->redirect(/** @scrutinizer ignore-call */ baseUrl('index.php?' . constant('CALL_CONTROLLER') . '=' . $this->shortName));
    }

    /**.
     * Returns the page details.
     *
     * @return array
     */
    public function pageDetails(): array
    {
        $details = [
            'title' => 'modules-title',
            'icon' => '<i class="fas fa-cogs"></i>',
            'description' => 'modules-description',
            'menu' => 'admin',
        ];
        return $details;
    }

    /**
     * Returns a list of actions buttons. By default returns Read/Update/Delete actions.
     * If some needs to be replace, replace it on final class.
     *
     * @param string $id
     *
     * @return array
     */
    public function getActionButtons(string $id = ''): array
    {
        $actionButtons = [];
        $actionButtons['enable'] = [
            'class' => 'btn btn-success btn-sm',
            'type' => 'button',
            'link' => $this->url . '&' . constant('METHOD_CONTROLLER') . '=enable&id=' . $id,

            'icon' => '<i class="far fa-check-square"></i>',
            'text' => $this->translator->trans('enable'),

        ];
        $actionButtons['disable'] = [
            'class' => 'btn btn-warning btn-sm',
            'type' => 'button',
            'link' => $this->url . '&' . constant('METHOD_CONTROLLER') . '=disable&id=' . $id,
            'icon' => '<i class="far fa-square"></i>',
            'text' => $this->translator->trans('disable'),
        ];

        $actionButtons = array_merge($actionButtons, parent::getActionButtons($id));
        $actionButtons = array_merge($actionButtons, parent::/** @scrutinizer ignore-call */ getActionButtons($id));
        unset($actionButtons['read'], $actionButtons['update']);

        return $actionButtons;
    }

    public function setTemplate(): string
    {
        return 'modules';
    }
}
rsanjoseo / alxarafe

Push — main ( f24735...83b0dc )

Modules::getActionButtons() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
