Extensiones de controladores

Para modificar el comportamiento o añadir pestañas o secciones a controladores de otros plugins (o del core) podemos usar una extensión, es decir, crearemos un archivo php con el mismo nombre que el controlador en la carpeta Extension/Controller de nuestro plugin.

Las extensiones no son herencia

Las extensiones no son herencia. No se puede extender cualquier función imaginable, solamente las que tienen soporte. Y cada función que añadas en una extensión debe tener un return function().

Ejemplo: añadir pestañas a un controlador

Las extensiones también sirven para poder añadir pestañas o cualquier método a controladores que ya existen. Siguiendo con el ejemplo vamos a añadir la pestaña de logs al listado de productos (controlador ListProducto). Para ello creamos el archivo Extension/Controller/ListProducto.php:

<?php
namespace FacturaScripts\Plugins\MiPLugin\Extension\Controller;

use Closure;

class ListProducto
{
   public function createViews(): Closure
   {
      return function() {
         $this->addView('ListLogMessage', 'LogMessage', 'log');
      };
   }
}

Recuerda que las funciones deben tener un return function() y que debes cargar la extensión desde el archivo Init.php del plugin.

Cargar extensiones en el Init.php

Las extensiones de archivos xml se integran automáticamente al activar el plugin o reconstruir Dinamic. En cambio, las extensiones de archivo php se deben cargar explícitamente, y se deben hacer desde el archivo Init.php del plugin, en el método init().

public function init() {
   $this->loadExtension(new Extension\Controller\ListProducto());
}

Métodos disponibles para extender

• createViews() se ejecuta una vez realizado el createViews() del controlador.
• execPreviousAction() se ejecuta después del execPreviousAction() del controlador. Si devolvemos false detenemos la ejecución del controlador.
• loadData() se ejecuta tras el loadData() del controlador. Recibe los parámetros $viewName y $view.
• execAfterAction() se ejecuta tras el execAfterAction() del controlador.

fsmaker

Para hacer este mismo proceso con fsmaker ejecutamos:

fsmaker extension

En el asistente elegimos controlador y escribimos el nombre del controlador.

¿No funciona?

Los errores más comunes son:

• Tener un namespace incorrecto. El namespace debe reflejar la ruta donde está el archivo. Si el archivo está en la carpeta Extension/Model de tu plugin, el namespace debe incluir Extension\Model.
• Intentar extender funciones que no soportan extensiones. Solamente las funciones o métodos indicados arriba se pueden extender.
• No usar return function(). Las funciones deben devolver un return function(), y si no, no funcionará. Si la función necesita parámetros, estos deben ir en el return function().
• No cargar la extensión desde el Init.php del plugin.

Parámetros por referencia

Si crear funciones personalizadas y estas incluyen parámetros no se debe poner "&" en los parámetros ya que no está permitido, y causará problemas. Como sugerencia puedes devolverte el parámetro que deseas modificar.

Ejemplo mal

public function applyStockChangesFromWork(): Closure
{
        return function (&$stock) {
            $stock->cantidad = 5;
        };
}

Ejemplo Bueno

public function applyStockChangesFromWork(): Closure
{
        return function ($stock) {
            $stock->cantidad = 5;
            return $stock;
        };
}