• 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
• 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

Cómo crear preferencias de aplicación para su plugin

Si necesita añadir opciones de configuración a su plugin, puede crear su propia sección en el apartado Por defecto (menú administrador > panel de control) de FacturaScripts. El controlador que gestiona estas secciones es EditSettings, un controlador especial que carga automáticamente una sección para cada archivo XML dentro de XMLView cuyo nombre comience con el prefijo Settings.

Ejemplos de archivos XML válidos:

default -> SettingsDefault.xml
email -> SettingsEmail.xml
logs -> SettingsLog.xml

myplugin -> SettingsMyPlugin.xml

Creación del archivo XML

Para crear una nueva sección de configuración, debe crear un archivo llamado SettingsMyPlugin.xml en la carpeta XMLView de su plugin. Recuerde que, al añadir un nuevo archivo XML, debe regenerar la configuración dinámica (menú administrador > Plugins > botón Reconstruir).

Aquí tiene un ejemplo del contenido que debe tener el archivo:

<?xml version="1.0" encoding="UTF-8"?>
<view>
    <columns>
        <group name="data" numcolumns="12">
            <column name="name" display="none" order="0">
                <widget type="text" fieldname="name" readonly="true" required="true" />
            </column>
            <column name="email" order="100">
                <widget type="text" fieldname="email" icon="fas fa-envelope" />
            </column>
        </group>
    </columns>
</view>

En este ejemplo, hemos nombrado el archivo SettingsMyPlugin.xml siguiendo el ejemplo de MyPlugin, pero puede darle cualquier nombre, siempre que inicie con Settings, sea un archivo XML y se encuentre dentro de la carpeta XMLView.

Columna 'name' Obligatoria

Los archivos de configuración deben incluir obligatoriamente una columna name para garantizar un funcionamiento correcto:

<column name="name" display="none" order="0">
   <widget type="text" fieldname="name" readonly="true" required="true" />
</column>

Leer configuración

Puede acceder a los valores de cualquiera de los campos de configuración de su plugin utilizando Tools::settings() desde cualquier controlador o modelo:

use FacturaScripts\Core\Tools;

Tools::settings('myplugin', 'nombre-campo');

No utilice EditSettings si...

Como ha visto, EditSettings permite añadir opciones de configuración simplemente añadiendo un archivo XMLView con el prefijo Settings. Sin embargo, si busca implementar funcionalidades más complejas, es recomendable crear su propio controlador.