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)
- Ejemplo correcto:
- min_version: Establece la versión mínima de FacturaScripts necesaria para el funcionamiento del plugin.
- Ejemplo:
min_version = 2022.6
- Ejemplo:
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
- Ejemplo correcto:
-
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'
- Ejemplo correcto:
-
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'
- Ejemplo correcto:
-
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 correcto:
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'
- Carpeta:
-
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).
- Carpeta: