Creación de plugins

Un plugin permite añadir nuevas funcionalidades a FacturaScripts. Así que si desea hacer cambios en el código de FacturaScripts, no modifique los archivos del núcleo, ya que al actualizar perderá esos cambios. Simplemente cree un plugin con los cambios que desea.

¿Cómo crear un plugin?

Lo primero que hace falta para crear un plugin es crear una nueva carpeta dentro de la carpeta Plugins. El nombre de la carpeta será el nombre del plugin, y este nombre debe comenzar por una letra y no contener espacios. Ejemplos:

• MiPlugin -> Bien
• 2021Plugin -> Mal, no puede comenzar por un número
• Mi Plugin -> Mal, no puede contener espacios

Dentro del plugin deberá tener la siguiente estructura de archivos y directorios:

• Assets/
  • CSS/
  • Images/
  • JS/
• Controller/
• Model/
• Table/
• Translation/
• View/
• XMLView/
• facturascripts.ini

Ejemplo: MyNewPlugin

Creamos la carpeta MyNewPlugin dentro de Plugins. Creamos las carpetas Assets, Controller, Model, Table, View y XMLView. Y además creamos el archivo facturascripts.ini:

description = 'My fantastic new plugin for FacturaScritps'
min_version = 2021
name = 'MyNewPlugin'
version = 1

Sólo con esto, nuestro plugin ya será reconocido y podríamos activarlo. Aunque aún no dispone de ninguna funcionalidad. Si no le funciona, lo más probable es que haya escrito mal el nombre facturascripts.ini

fsmaker

También puede crear rápidamente la estructura de plugins, modelos y controladores con fsmaker, la nueva herramienda en línea de comandos de FacturaScripts. Disponible para Linux y macOS.

fsmaker plugin

Espacios de nombres:

Cada clase debe estar en el espacio de nombres correspondiente a su carpeta, por ejemplo, la clase Producto pertenece al espacio de nombres FacturaScripts\Core\Model\Producto porque está en el directorio Core\Model.

Cada plugin tiene su espacio de nombres reservado, que corresponde con FacturaScripts\Plugins\{NOMBRE_DEL_PLUGIN}, es decir, los controladores del plugin MyPlugin tendrán el correspondiente namespace:

namespace FacturaScripts\Plugins\MyPlugin\Controller;

El sistema de prioridades de plugins

El último plugin activo tiene prioridad sobre el anterior, y así sucesivamente. Puede leer más detalles sobre el sistema de prioridades aquí.

El modo debug

Para mayor comodidad podemos activar el modo debug, que nos habilitará la barra de debug, abajo a la derecha, y nos facilitará el proceso de reconstruir. Simplemente debemos editar el archivo config.php del directorio de FacturaScripts y poner a true la constante FS_DEBUG.

define('FS_DEBUG', true);