crear-extension

Skill: Crear Extensión FacturaScripts

Las extensiones permiten añadir funcionalidad a clases del core o de otros plugins sin modificar su código fuente.

Atajo con fsmaker

Antes de crear los archivos a mano, considera usar la herramienta CLI:

fsmaker extension

fsmaker solicita el tipo de extensión (tabla, modelo, controlador, XMLView o vista Twig) y el nombre de la clase a extender, y genera el archivo base con la estructura correcta. Los apartados siguientes documentan la estructura completa para cuando necesites ajustar o completar la extensión manualmente.

Extensión de Modelo

Archivo: Plugins/MiPlugin/Extension/Model/NombreModelo.php

<?php

namespace FacturaScripts\Plugins\MiPlugin\Extension\Model;

use Closure;

class NombreModelo
{
    // Se ejecuta ANTES de guardar el modelo
    public function saveInsert(): Closure
    {
        return function () {
            // $this es el modelo original
            // Código a ejecutar antes de insertar
        };
    }

    // Se ejecuta DESPUÉS de guardar
    public function saveUpdate(): Closure
    {
        return function () {
            // Código a ejecutar después de actualizar
        };
    }

    // Se ejecuta al eliminar
    public function delete(): Closure
    {
        return function () {
            // Código a ejecutar al eliminar
        };
    }

    // Se ejecuta en test() (validación)
    public function test(): Closure
    {
        return function () {
            // Añadir validaciones extra
            // Retorna void, el pipe continúa
        };
    }
}

Métodos disponibles para extender en modelos

• clear() — al instanciar el modelo, asigna valores predeterminados
• delete() — tras el delete() del modelo
• deleteBefore() — antes del delete(); si devuelve false, impide el borrado
• save() — tras el save() del modelo
• saveBefore() — antes del save(); si devuelve false, impide el guardado
• saveInsert() — tras el saveInsert() del modelo
• saveInsertBefore() — antes del saveInsert(); si devuelve false, lo impide
• saveUpdate() — tras el saveUpdate() del modelo
• saveUpdateBefore() — antes del saveUpdate(); si devuelve false, lo impide
• test() — tras el test() del modelo
• testBefore() — antes del test(); si devuelve false, lo impide
• url() — tras el url() del modelo
• onChange() — antes del saveUpdate(), para detectar cambios en columnas