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 las preferencias de aplicación del panel de control de FacturaScripts. El controlador que lo gestiona es EditSettings, un controlador especial que carga automáticamente una sección para cada archivo xml dentro de XMLView y cuyo nombre comience por el prefijo Settings.

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

myplugin -> SettingsMyPlugin.xml

Crear el archivo xml

Cree el archivo SettingsMyPlugin.xml dentro de la carpeta XMLView de su plugin. Recuerde que cuando añade un nuevo archivo xml debe regenerar el dinamic (menú administrador > panel de control > plugins, botón regenerar).

<?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 llamado al archivo SettingsMyPlugin.xml por seguir con el ejemplo de MyPlugin, pero puede llamar al archivo como le de la gana siempre que comience por Settings, sea un xml y esté dentro de la carpeta XMLView.

Imprescindible la columna name

Los archivos settings deben tener obligatoriamente una columna name para un correcto funcionamiento:

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

Leer configuración

Puede leer los valores de cualquiera de los campos de la configuración de su plugin llamando a ToolBox desde cualquier controlador o modelo.

$valor = $this->toolBox()->appSettings()->get('myplugin', 'nombre-campo');

No use EditSettings si...

Como ya ha visto EditSettings le permite añadir opciones de configuración con solamente añadir un archivo XMLView con prefijo Settings, pero si lo que busca es algo más complejo, mejor cree su propio controlador.