Los controladores

Un controlador es básicamente una página o una opción del menú de FacturaScripts. Si hace clic en el menú 'Almacén -> Productos' estará ejecutando el controlador ListProducto.php ¿Cómo saber qué controlador está ejecutando? Fíjese en la barra de direcciones del navegador.

• Los controladores deben ir en la carpeta Controller de su plugin.
• El nombre del archivo debe ser el mismo que el de la clase que contiene.
• La clase debe heredar de FacturaScripts\Core\Base\Controller o de uno de los controladores extendidos.

Ejemplo: MyNewController.php

<?php
namespace FacturaScripts\Plugins\MyNewPlugin\Controller;

use FacturaScripts\Core\Base\Controller;

class MyNewController extends Controller
{
    public function getPageData(): array
    {
        $pageData = parent::getPageData();
        $pageData['menu'] = 'admin';
        $pageData['title'] = 'MyNewController';
        $pageData['icon'] = 'fas fa-page';
        return $pageData;
    }

    public function privateCore(&$response, $user, $permissions)
    {
        parent::privateCore($response, $user, $permissions);

        // tu código aquí
    }

    public function publicCore(&$response)
    {
        parent::publicCore($response);

        // tu código aquí
    }
}

En este ejemplo hemos añadido esta página al menú admin, con el título MyNewController y el icono fas fa-page. Además, en la función privateCore() hemos indicado que se va a utilizar la plantilla MyNewController, que se corresponde con el archivo MyNewController.html.twig de la carpeta View.

getPageData()

Esta función sirve para indicar de qué forma aparece esta página en el menú, es decir, dentro de qué menú, con qué título e icono. Y será ejecutada por el núcleo de FacturaScripts cada vez que se ejecute el controlador, o bien al activar o actualizar el plugin. Devuelve un array con los siguientes datos:

• name: nombre de la clase del controlador. No se debe cambiar.
• title: título de la página. Se traducirá utilizando el traductor integrado.
• icon: icono a mostrar en el menú.
• menu: menú en el que aparecerá.
• submenu: submenú en el que aparecerá.
• showonmenu: TRUE para mostrar en el menú (por defecto), FALSE para ocultar.
• ordernum: orden de prioridad al mostrar en el menú. Cuando más bajo, más arriba aparece.

privateCore() y publicCore()

FacturaScripts no solamente sirve para que usted y sus empleados gestionen su empresa, sino que también permite que pueda ofrecer servicio a sus clientes. Es decir, pueden acceder tanto administradores, empleados o clientes. Por este motivo hay una separación entre lo que unos y otros pueden ver. Y esta separación se traduce en el controlador en el siguiente comportamiento:

• Si el usuario ha sido correctamente autenticado, se ejecutará la función privateCore() del controlador.
• De lo contrario se ejecutará la función publicCore() que, a menos que implemente algo distinto, mostrará la pantalla de login.

Lo habitual es implementar la lógica en la función privateCore().

Herencia de controladores

Puede heredar y personalizar cualquier controlador existente, pero recuerde que debe utilizar un alias antes de heredar. Aquí tiene un ejemplo:

<?php
namespace FacturaScripts\Plugins\MyNewPlugin\Controller;

use FacturaScripts\Core\Controller\EditCliente as ParentController;

class EditCliente extends ParentController
{
    // tu código aquí
}

Fíjese en la línea 'use FacturaScripts\Core\Controller\EditCliente as ParentController;'. Ese as es para utilizar EditCliente con el alias de ParentController. Si no usa un alias tendrá una colisión de nombres al definir la nueva clase, ya que esta se llama igual que la clase de la que deseea heredar.