• 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
  • Obtener el PDF de una factura
  • Modificar registros
  • Eliminar registros

El archivo facturascripts.ini

El archivo facturascripts.ini es imprescindible para cada plugin, ya que define información clave sobre el mismo. A continuación, se describen los campos que debe contener y las recomendaciones para su correcta utilización.

Campos Obligatorios

• name: Indica el nombre del plugin. Debe coincidir exactamente con el nombre del directorio del plugin.
• description: Proporciona una descripción breve pero completa del plugin.
• version: Especifica la versión del plugin. Debe ser un número entero o decimal.
  • Ejemplo correcto: version = 1.0
  • Ejemplo incorrecto: version = 1.0.1 (no se acepta formato triple)
  • Ejemplo incorrecto: version = 1.0-beta (se debe utilizar formato decimal)
• min_version: Establece la versión mínima de FacturaScripts necesaria para el funcionamiento del plugin.
  • Ejemplo: min_version = 2022.6

Campos Opcionales

• min_php: Define la versión mínima de PHP requerida. Debe usarse un formato decimal.

  • Ejemplo correcto: min_php = 7.2
  • Ejemplo incorrecto: min_php = 7.4.5

• require: Lista los plugins requeridos para que el plugin funcione correctamente. Si son varios, deben estar separados por comas sin espacios.

  • Ejemplo correcto: require = 'POS'
  • Ejemplo incorrecto: require = 'POS, Servicios' (no se deben incluir espacios)
  • Ejemplo correcto: require = 'POS,Servicios'

• require_php: Especifica las extensiones de PHP necesarias, separadas por comas sin espacios.

  • Ejemplo correcto: require_php = 'soap'
  • Ejemplo incorrecto: require_php = 'soap, imap' (no se deben incluir espacios)
  • Ejemplo correcto: require_php = 'soap,imap'

• compatible: Indica los plugins compatibles. La lista debe escribirse sin espacios después de las comas.

  • Ejemplo correcto: compatible = 'POS'
  • Ejemplo incorrecto: compatible = 'POS, Servicios'
  • Ejemplo correcto: compatible = 'POS,Servicios'

Ejemplo de facturascripts.ini

A continuación se muestra un ejemplo básico del archivo:

name = 'MyNewPlugin'
description = 'My fantastic new plugin for FacturaScripts'
version = 1
min_version = 2022.6

Este ejemplo indica que se trata del plugin MyNewPlugin, en su versión 1, y que requiere FacturaScripts 2022.6 o una versión superior para su funcionamiento.

Detalle del Campo: name

El campo name indica el nombre del plugin y debe coincidir exactamente con el nombre del directorio en el que se encuentra el plugin. Errores comunes incluyen:

• Errores tipográficos en el nombre del archivo facturascripts.ini (por ejemplo, añadir o faltar una 's').
• Inconsistencias entre el nombre del directorio y el valor del campo name.

Ejemplos de Casos Correctos e Incorrectos

• Correcto:

  • Carpeta: Miplugin
  • Configuración: name = 'Miplugin'

• Incorrecto:

  • Carpeta: Mi plugin y configuración: name = 'Miplugin' (no se deben usar espacios en el nombre de la carpeta).
  • Carpeta: Miplugin y configuración: name = 'MiPlugin' (la 'p' debe estar en minúscula para mantener la coherencia).