• Antes de empezar a programar +
  • ¿Qué versión de Symfony utiliza?
  • Sistema de Prioridades de Plugins
  • Diagramas de tablas
  • Cómo hacer un pull-request
• Creación de Plugins
  • El archivo facturascripts.ini
  • El archivo Init.php
  • Los Controladores +
    • Controladores extendidos +
      • ListController en FacturaScripts +
        • addFilterAutocomplete()
        • addFilterCheckbox()
        • addFilterDatePicker()
        • addFilterNumber()
        • addFilterPeriod()
        • addFilterSelect()
        • addFilterSelectWhere()
      • EditController
      • PanelController +
        • addHtmlView()
        • addEditView()
        • addEditListView()
        • addListView()
      • Personalizando con Settings
      • Método disableColumn()
      • Interacción con las Vistas
    • Obtener Parámetros de la URL, Formularios o Cookies
    • Cómo guardar una cookie
    • Consultar el usuario y sus permisos
    • Formularios de edición de facturas, albaranes, etc
  • Añadir un Endpoint a la API
  • Los modelos +
    • Operaciones comunes con modelos
    • XML de la tabla
    • ModelOnChangeClass
    • Modelos de Más de Una Tabla
    • Modelos Especiales
    • Cómo crear una factura, albarán, pedido o presupuesto
    • Herencia de Modelos
    • $modelo->install()
    • $modelo->all()
    • $modelo->clear()
    • $modelo->count()
    • $modelo->delete()
    • $modelo->exists()
    • $modelo->loadFromData()
    • $modelo->get()
    • $modelo->getModelFields()
    • $modelo->loadFromCode()
    • $modelo->primaryColumnValue()
    • $modelo->primaryColumn()
    • $modelo->newCode()
    • $modelo->tableName()
    • $modelo->save()
    • $modelo->primaryDescription()
    • $modelo->primaryDescriptionColumn()
    • $modelo->url()
    • $modelo->test()
  • Las vistas HTML +
    • Iconos disponibles
    • Herencia de plantillas
  • Las vistas XML (XMLView) +
    • Columns
    • Rows +
      • Row status
      • Row statistics
      • Row actions
      • Row header y footer
    • Modals
    • Group
    • Column
    • Widgets +
      • Widget Autocomplete
      • Widget Bytes
      • Widget Checkbox
      • Widget Color
      • Widget Datalist
      • Widget Date
      • Widget Datetime
      • Widget File
      • Widget Library
      • Widget Link
      • Widget Money
      • Widget Number
      • Widget Password
      • Widget Select
      • Widget Stars
      • Widget Text
      • Widget Textarea
      • Widget Time
      • Widget Radio
      • Widget Variante
  • Las traducciones en Plugins
  • Las extensiones +
    • Extensiones de controladores
    • Extensiones de modelos
    • Extensiones de tablas
    • Extensiones de XMLView
    • Extensiones de Vistas HTML
  • Mostrar mensajes, errores y alertas
  • Acceso a la Base de Datos +
    • DbQuery
    • Where
    • DataBaseWhere
  • Settings: opciones del panel de control +
    • Cómo crear preferencias de aplicación para su plugin
  • Generación de PDF y Excel
  • AssetManager
  • El archivo Cron.php
  • Cómo publicar plugins
• Profundizando en el CORE +
  • Enrutado
  • Gestión de Errores
  • Gestión de Plugins
  • Uso de la caché
  • La cola de trabajos
  • Descarga de Archivos desde MyFiles
  • Cliente de API de OpenAI
  • Cliente HTTP +
    • Conectar con otro FacturaScripts mediante API
  • Validar Emails, Cadenas y URLs
  • Enviar emails con NewMail
• Test unitarios en plugins +
  • Añadir github action
• Migración de plugins antiguos +
  • Row Business (Obsoleto)
  • Migrar los XML de las tablas de 2017
  • Migrar Modelos de 2017
  • addGridView() - (obsoleto)
• La API REST +
  • Listado de recursos
  • Listar, filtrar y ordenar registros
  • Obtener un registro concreto
  • Crear o añadir registros
  • Cómo crear facturas
  • Hacer una factura rectificativa
  • Obtener el PDF de una factura
  • Modificar registros
  • Eliminar registros

Creación de Plugins

Un plugin permite añadir nuevas funcionalidades a FacturaScripts. Si desea realizar cambios en el código de FacturaScripts, no modifique los archivos del núcleo, ya que al actualizar perderá esos cambios. En su lugar, debe crear un plugin con las modificaciones deseadas.

¿Cómo crear un plugin?

Para crear un plugin, lo primero que necesita es crear una nueva carpeta dentro de la carpeta Plugins. El nombre de la carpeta será el nombre del plugin y debe comenzar con una letra, sin contener espacios. Ejemplos:

• MiPlugin → Correcto
• 2024Plugin → Incorrecto, no puede comenzar con un número
• Mi Plugin → Incorrecto, no puede contener espacios

Dentro del directorio del plugin, debe tener la siguiente estructura de archivos y carpetas:

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

Ejemplo: MyNewPlugin

Cree la carpeta MyNewPlugin dentro de Plugins. Luego, dentro de ella, cree las carpetas Assets, Controller, Model, Table, View y XMLView. También necesita crear el archivo [facturascripts.ini](https://facturascripts.com/publicaciones/el-archivo-facturascripts-ini-37) con el siguiente contenido:

name = 'MyNewPlugin'
description = 'Mi fantástico nuevo plugin para FacturaScripts'
version = 1
min_version = 2023

Una vez hecho esto, su plugin será reconocido y podrá activarlo, aunque aún no tendrá ninguna funcionalidad. Si no le funciona, es probable 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 herramienta de 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 se encuentra en el directorio Core\Model.

Cada plugin tiene su espacio de nombres reservado, correspondiente a FacturaScripts\Plugins{NOMBRE_DEL_PLUGIN}. Por ejemplo, los controladores del plugin MyPlugin tendrán el siguiente namespace:

namespace FacturaScripts\Plugins\MyPlugin\Controller;

El sistema de prioridades de plugins

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

El modo debug

Para mayor comodidad, puede activar el modo debug, que habilitará la barra de debug en la parte inferior derecha, facilitando el proceso de depuración. Simplemente edite el archivo config.php en el directorio de FacturaScripts y configure la constante FS_DEBUG a true.

define('FS_DEBUG', true);

Para más detalles sobre esta barra de debug y consejos para depurar errores, puede consultar el curso de sesiones de programación.