Alxarafe\Core\Base\BasicController

Complexity

Total Complexity

13

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	doAction()	0	12	3
A	doExit()	0	4	1
A	preLoad()	0	4	1
A	__construct()	0	7	2
A	url()	0	3	1
A	addCSS()	0	2	1
A	addJS()	0	2	1
A	doSave()	0	3	1
A	main()	0	8	2

<?php
/**
 * Alxarafe. Development of PHP applications in a flash!
 * Copyright (C) 2018 Alxarafe <info@alxarafe.com>
 */

namespace Alxarafe\Core\Base;

use Alxarafe\Core\Helpers\Globals;
use Alxarafe\Core\Singletons\Render;
use DebugBar\DebugBarException;

/**
 * Class BasicController
 *
 * Define el controlador básico.
 * No requiere uso de base de datos ni de autenticación.
 *
 * @author  Rafael San José Tovar <info@rsanjoseo.com>
 * @version 2023.0108
 *
 * @package Alxarafe\Core\Base
 */
abstract class BasicController
{
    /**
     * Indica si hay que proteger la edición de la salida o cierre accidental del navegador.
     * Si true, se necesita pulsar el botón aceptar o cancelar, o confirmar el cierre.
     *
     * @var bool
     */
    public bool $protectedClose;

    /**
     * Contiene la acción a ejecutar por el controlador o null, si no hay acción.
     *
     * @var string|null
     */
    public ?string $action;

    /**
     * Indica si hay o no menú que mostrar.
     * Los controladores básicos no usan menú.
     *
     * @var bool
     */
    public bool $hasMenu = false;

    /**
     * Contiene una instancia de la clase View o nulo si no ha sido asignada.
     *
     * @var View
     */
    public View $view;

    /**
     * BasicController constructor
     */
    public function __construct()
    {
        // parent::__construct();

        $this->protectedClose = false;
        if (!$this->preLoad()) {
            trigger_error('preLoad fails!');
        }
    }

    /**
     * Realiza la carga inicial de variables del controlador.
     *
     * @author  Rafael San José Tovar <info@rsanjoseo.com>
     * @version 2023.0108
     *
     * @return bool
     */
    public function preLoad(): bool
    {
        $this->action = filter_input(INPUT_POST, 'action');
        return true;
    }

    /**
     * Forma la ruta para recargar usando el mismo módulo y controlador, ignorando
     * el resto de variables GET.
     *
     * @param string $module
     * @param string $controller
     *
     * @return string
     */
    public static function url(string $module = Globals::DEFAULT_MODULE_NAME, string $controller = Globals::DEFAULT_CONTROLLER_NAME): string
    {
        return BASE_URI . '?' . Globals::MODULE_GET_VAR . '=' . $module . '&' . Globals::CONTROLLER_GET_VAR . '=' . $controller;
    }

    /**
     * Punto de entrada del controlador.
     * El dispatcher:
     * - En primer lugar instancia (carga el controlador y se ejecuta el __construct)
     * - Y a continuación, lanza el método indicado, por defecto es main()
     *
     * @author  Rafael San José Tovar <info@rsanjoseo.com>
     * @version 2023.0108
     *
     * @return void
     * @throws DebugBarException
     */
    public function main(): void
    {
        $result = true;

The assignment to $result is dead and can be removed.

        if (isset($this->action)) {
            $result = $this->doAction();
        }
        Render::setTemplate($this->setTemplate());
        $view = new View($this);

The assignment to $view is dead and can be removed.

        // $view->render();
    }

    /**
     * Ejecuta una acción
     *
     * @author  Rafael San José Tovar <info@rsanjoseo.com>
     * @version 2023.0108
     *
     * @return bool
     */
    public function doAction(): bool
    {
        switch ($this->action) {
            case 'save':
                return $this->doSave();
            case 'exit':
                $this->doExit();
                break;
            default:
                trigger_error("The '$this->action' action has not been defined!");
        }
        return true;
    }

    /**
     * Guarda los cambios. Por defecto no hace nada, hay que sobreescribirlo.
     * TODO: Analizar si puede convenir que sea un método abstracto.
     *       Podría ser un método abstracto, pero es posible que no sea necesario.
     *
     * @author  Rafael San José Tovar <info@rsanjoseo.com>
     * @version 2023.0108
     *
     * @return bool
     */
    public function doSave(): bool
    {
        return true;
    }

    /**
     * Regresa a la pantalla principal.
     *
     * @author  Rafael San José Tovar <info@rsanjoseo.com>
     * @version 2023.0108
     *
     */
    public function doExit(): void
    {
        header('Location: ' . BASE_URI);
        die();
    }

    /**
     * Method to assign the template to the view.
     */
    abstract public function setTemplate(): string;

    /**
     * addCSS includes the common CSS files to all views templates. Also defines CSS folders templates.
     *
     * @return void
     * @throws DebugBarException
     */
    public function addCSS()
    {
        //        $this->addToVar('cssCode', $this->addResource('/bower_modules/bootstrap/dist/css/bootstrap.min', 'css'));
        //        $this->addToVar('cssCode', $this->addResource('/css/alxarafe', 'css'));
    }

    /**
     * addJS includes the common JS files to all views templates. Also defines JS folders templates.
     *
     * @return void
     */
    public function addJS()
    {
        //        $this->addToVar('jsCode', $this->addResource('/bower_modules/jquery/dist/jquery.min', 'js'));
        //        $this->addToVar('jsCode', $this->addResource('/bower_modules/bootstrap/dist/js/bootstrap.min', 'js'));
        //        $this->addToVar('jsCode', $this->addResource('/js/alxarafe', 'js'));
    }

}