BasicController::addJS() - 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

BasicController::addJS() A

↳ Parent: BasicController

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	0

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
/**
 * Alxarafe. Development of PHP applications in a flash!
 * Copyright (C) 2018 Alxarafe <[email protected]>
 */

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 <[email protected]>
 * @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 <[email protected]>
     * @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 <[email protected]>
     * @version 2023.0108
     *
     * @return void
     * @throws DebugBarException
     */
    public function main(): void
    {
        $result = true;

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

        // $view->render();
    }

    /**
     * Ejecuta una acción
     *
     * @author  Rafael San José Tovar <[email protected]>
     * @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 <[email protected]>
     * @version 2023.0108
     *
     * @return bool
     */
    public function doSave(): bool
    {
        return true;
    }

    /**
     * Regresa a la pantalla principal.
     *
     * @author  Rafael San José Tovar <[email protected]>
     * @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'));
    }

}


1			<?php
2			/**
3			* Alxarafe. Development of PHP applications in a flash!
4			* Copyright (C) 2018 Alxarafe <[email protected]>
5			*/
6
7			namespace Alxarafe\Core\Base;
8
9			use Alxarafe\Core\Helpers\Globals;
10			use Alxarafe\Core\Singletons\Render;
11			use DebugBar\DebugBarException;
12
13			/**
14			* Class BasicController
15			*
16			* Define el controlador básico.
17			* No requiere uso de base de datos ni de autenticación.
18			*
19			* @author Rafael San José Tovar <[email protected]>
20			* @version 2023.0108
21			*
22			* @package Alxarafe\Core\Base
23			*/
24			abstract class BasicController
25			{
26			/**
27			* Indica si hay que proteger la edición de la salida o cierre accidental del navegador.
28			* Si true, se necesita pulsar el botón aceptar o cancelar, o confirmar el cierre.
29			*
30			* @var bool
31			*/
32			public bool $protectedClose;
33
34			/**
35			* Contiene la acción a ejecutar por el controlador o null, si no hay acción.
36			*
37			* @var string\|null
38			*/
39			public ?string $action;
40
41			/**
42			* Indica si hay o no menú que mostrar.
43			* Los controladores básicos no usan menú.
44			*
45			* @var bool
46			*/
47			public bool $hasMenu = false;
48
49			/**
50			* Contiene una instancia de la clase View o nulo si no ha sido asignada.
51			*
52			* @var View
53			*/
54			public View $view;
55
56			/**
57			* BasicController constructor
58			*/
59			public function __construct()
60			{
61			// parent::__construct();
62
63			$this->protectedClose = false;
64			if (!$this->preLoad()) {
65			trigger_error('preLoad fails!');
66			}
67			}
68
69			/**
70			* Realiza la carga inicial de variables del controlador.
71			*
72			* @author Rafael San José Tovar <[email protected]>
73			* @version 2023.0108
74			*
75			* @return bool
76			*/
77			public function preLoad(): bool
78			{
79			$this->action = filter_input(INPUT_POST, 'action');
80			return true;
81			}
82
83			/**
84			* Forma la ruta para recargar usando el mismo módulo y controlador, ignorando
85			* el resto de variables GET.
86			*
87			* @param string $module
88			* @param string $controller
89			*
90			* @return string
91			*/
92			public static function url(string $module = Globals::DEFAULT_MODULE_NAME, string $controller = Globals::DEFAULT_CONTROLLER_NAME): string
93			{
94			return BASE_URI . '?' . Globals::MODULE_GET_VAR . '=' . $module . '&' . Globals::CONTROLLER_GET_VAR . '=' . $controller;
95			}
96
97			/**
98			* Punto de entrada del controlador.
99			* El dispatcher:
100			* - En primer lugar instancia (carga el controlador y se ejecuta el __construct)
101			* - Y a continuación, lanza el método indicado, por defecto es main()
102			*
103			* @author Rafael San José Tovar <[email protected]>
104			* @version 2023.0108
105			*
106			* @return void
107			* @throws DebugBarException
108			*/
109			public function main(): void
110			{
111			$result = true;
			0 ignored issues – show Unused Code introduced 2023-02-26 11:28 UTC by Report Bug Copy Issue Report The assignment to `$result` is dead and can be removed. Loading history...
112			if (isset($this->action)) {
113			$result = $this->doAction();
114			}
115			Render::setTemplate($this->setTemplate());
116			$view = new View($this);
			0 ignored issues – show Unused Code introduced 2023-02-26 11:28 UTC by Report Bug Copy Issue Report The assignment to `$view` is dead and can be removed. Loading history...
117			// $view->render();
118			}
119
120			/**
121			* Ejecuta una acción
122			*
123			* @author Rafael San José Tovar <[email protected]>
124			* @version 2023.0108
125			*
126			* @return bool
127			*/
128			public function doAction(): bool
129			{
130			switch ($this->action) {
131			case 'save':
132			return $this->doSave();
133			case 'exit':
134			$this->doExit();
135			break;
136			default:
137			trigger_error("The '$this->action' action has not been defined!");
138			}
139			return true;
140			}
141
142			/**
143			* Guarda los cambios. Por defecto no hace nada, hay que sobreescribirlo.
144			* TODO: Analizar si puede convenir que sea un método abstracto.
145			* Podría ser un método abstracto, pero es posible que no sea necesario.
146			*
147			* @author Rafael San José Tovar <[email protected]>
148			* @version 2023.0108
149			*
150			* @return bool
151			*/
152			public function doSave(): bool
153			{
154			return true;
155			}
156
157			/**
158			* Regresa a la pantalla principal.
159			*
160			* @author Rafael San José Tovar <[email protected]>
161			* @version 2023.0108
162			*
163			*/
164			public function doExit(): void
165			{
166			header('Location: ' . BASE_URI);
167			die();
168			}
169
170			/**
171			* Method to assign the template to the view.
172			*/
173			abstract public function setTemplate(): string;
174
175			/**
176			* addCSS includes the common CSS files to all views templates. Also defines CSS folders templates.
177			*
178			* @return void
179			* @throws DebugBarException
180			*/
181			public function addCSS()
182			{
183			// $this->addToVar('cssCode', $this->addResource('/bower_modules/bootstrap/dist/css/bootstrap.min', 'css'));
184			// $this->addToVar('cssCode', $this->addResource('/css/alxarafe', 'css'));
185			}
186
187			/**
188			* addJS includes the common JS files to all views templates. Also defines JS folders templates.
189			*
190			* @return void
191			*/
192			public function addJS()
193			{
194			// $this->addToVar('jsCode', $this->addResource('/bower_modules/jquery/dist/jquery.min', 'js'));
195			// $this->addToVar('jsCode', $this->addResource('/bower_modules/bootstrap/dist/js/bootstrap.min', 'js'));
196			// $this->addToVar('jsCode', $this->addResource('/js/alxarafe', 'js'));
197			}
198
199			}
200

rsanjoseo / alxarafe

Push — main ( f24735...83b0dc )

BasicController::addJS() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like