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;

class MyNewController extends \FacturaScripts\Core\Base\Controller {

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

    public function privateCore(&$response, $user, $permissions)
    {
        parent::privateCore($response, $user, $permissions);
        // 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(): array

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 {
}

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.


Siguiente

Necesita identificarse para continuar con esta acción. Haga clic en iniciar sesión o cree una cuenta.

Iniciar sesión
PRO
neorazorx_1
neorazorx_1

España, 9 años, nivel 100

Creación de plugins

Patrocinadores

FacturaScripts avanza más rápido gracias al apoyo financiero de los patrocinadores, que contribuyen a que podamos dedicar más tiempo al desarrollo, testeo y documentación. Usted también puede poner su granito de arena y convertirse en patrocinador ;-)

ORO
elurk_3992
ORO
alexis_8932
ORO
manel_11440
PLATA
tomasono.correos_15524
PLATA
contacto_14936
PLATA
cpagannavarro_8262
PLATA
j.rodriguez_4692
PLATA
cristian.narvaez.vargas_9523
BRONCE
ldardon_11876
BRONCE
rexmaris_12857
BRONCE
flecamas_12738
BRONCE
jlgonzalezdiaz_12316
BRONCE
petrolboxip_12082
BRONCE
jairomor1963_13018
PRO
neorazorx_1
PRO
civernet_11724
PRO
jmoreno_2610
PRO
prebac_1378
PRO
daniel89fg_739
Patrocinar

Amplíe sus conocimientos con los cursos oficiales

Curso básico de programación

Con este curso aprenderá cómo crear un plugin sencillo para FacturaScripts 2021: añadir nuevas páginas, tablas y columnas. Para entender este curso no se necesita mucha experiencia en programación, le enseñaremos los básico para modelar problemas sencillos. ¿A quién va dirigido? A cualquier persona con unos conocimientos muy básicos de programación. ¿Qué incluye? 18 lecciones con 14 vídeos explicativos.

290 9,99 €
Sesiones de programación

Esta es una recopilación de vídeos y documentación de pequeños desarrollos sobre FacturaScripts y sus plugins. Perfecto para expandir tus conocimientos de programación. ¿A quién va dirigido? A personas que ya hayan superado el curso básico de programación y busquen ampliar sus conocimientos. ¿Qué incluye? 15 lecciones con 15 vídeos explicativos (más de 6 horas de vídeos) y el código fuente de los ejemplos. Novedades mensuales: Este curso se amplía cada mes con nuevas lecciones.

73 19,99 €
Cookies
Usamos cookies en nuestro sitio web para brindarte la experiencia más relevante recordando tus preferencias y visitas repetidas. Al hacer clic en "Aceptar", aceptas el uso de TODAS las cookies necesarias.

Copyright (c) 2013-2022 FacturaScripts

Soporte