Modelos de más de una tabla

En ocasiones necesitamos mostrar listados que consulten más de una tabla. Si los widget select o autocomplete no resolviesen nuestro problema, podemos usar los JoinModel para solucionarlo.

El JoinModel

Este es un tipo especial de modelo que se utiliza para listados, es decir, no está diseñador para crear, editar o eliminar datos. Solamente para listados.

Ejemplo de JoinModel

Debemos crear una clase en la carpeta Model/Join de nuestro plugin que herede de Core/Model/Base/JoinModel e implemente los métodos getTables(), getFields() y getSQLFrom(), que son los métodos que indicarán qué tablas y campos utilizar.

Model/Join/PartidaAsiento.php: en este ejemplo vamos a crear un JoinModel que combine las tablas partidas y asientos.

namespace FacturaScripts\Plugins\MyNewPlugin\Model\Join;

class PartidaAsiento extends \FacturaScripts\Core\Model\Base\JoinModel
{
    protected function getFields(): array
    {
        return [
            'concepto' => 'partidas.concepto',
            'debe' => 'partidas.debe',
            'fecha' => 'asientos.fecha',
            'haber' => 'partidas.haber',
            'idasiento' => 'partidas.idasiento',
            'idpartida' => 'partidas.idpartida',
            'numero' => 'asientos.numero'
        ];
    }

    protected function getSQLFrom(): string
    {
        return 'partidas LEFT JOIN asientos ON partidas.idasiento = asientos.idasiento';
    }

    protected function getTables(): array
    {
        return ['asientos', 'partidas'];
    }
}

getTables()

Debe devolver el listado de tablas que vamos a utilizar.

protected function getTables(): array
{
    return [
        'asientos',
        'partidas',
        'subcuentas'
    ];
}

getFields()

Debe devolver un array asociativo con los campos que vamos a utilizar y a qué tabla corresponden.

protected function getFields(): array
{
    return [
        'codejercicio' => 'asientos.codejercicio',
        'codcuentaesp' => 'subcuentas.codcuentaesp',
        'descripcion' => 'cuentasesp.descripcion',
        'codimpuesto' => 'subcuentas.codimpuesto',
        'iva' => 'partidas.iva',
        'recargo' => 'partidas.recargo',
        'baseimponible' => 'SUM(partidas.baseimponible)'
    ];
}

getSQLFrom()

Debe devolver el SQL con los JOIN correspondientes.

protected function getSQLFrom(): string
{
    return 'asientos'
        . ' INNER JOIN partidas ON partidas.idasiento = asientos.idasiento'
        . ' INNER JOIN subcuentas ON subcuentas.idsubcuenta = partidas.idsubcuenta'
        . ' AND subcuentas.codimpuesto IS NOT NULL'
        . ' AND subcuentas.codcuentaesp IS NOT NULL'
        . ' LEFT JOIN cuentasesp ON cuentasesp.codcuentaesp = subcuentas.codcuentaesp';
}

Métodos opcionales

getGroupFields()

Para los casos que deseemos agrupar información para obtener totales o datos estadísticos podemos definir las cláusulas group by y having de la sentencia SQL mediante la declaración de este método. Debemos devolver una cadena de texto con el valor a aplicar.

protected function getGroupFields(): string
{
    return 'asientos.codejercicio, subcuentas.codcuentaesp,'
        . 'cuentasesp.descripcion, subcuentas.codimpuesto,'
        . 'partidas.iva, partidas.recargo';
}

primaryColumnValue()

Con este metodo podemos especificar cual es la clave primaria. De este modo al cargar el JoinModel los checkbox de cada fila añadiran en su atributo value la clave primaria de cada final. Este método es necesario si necesitamos añadir alguna función extra, como un botón personalizado que haga algo con los checkbox seleccionados.

public function primaryColumnValue()
{
    return $this->codejercicio;
}

Edición y borrado de datos

Como se ha dicho, este modelo no permite la edición ni borrado directamente puesto que usa distintas tablas en el proceso de visualización de datos, pero se ha incluido un método que permite establecer un modelo como principal sobre el que se realizarán los procesos de edición y borrado.

Para establecer el modelo principal se debe llamar al método setMasterModel() desde el constructor pasándole una instancia del modelo.

public function __construct($data = [])
{
   parent::__construct($data);
   $this->setMasterModel(new Cliente());
}

clear() y loadFromData()

Si necesitamos calcular algunos valores, podemos usar los métodos clear() o loadFromData() para ello.

public function clear()
{
    parent::clear();
    $this->cuotaiva = 0.00;
    $this->cuotarecargo = 0.00;
    $this->total = 0.00;
}

protected function loadFromData($data)
{
    parent::loadFromData($data);
    $this->cuotaiva = $this->baseimponible * ($this->iva / 100.00);
    $this->cuotarecargo = $this->baseimponible * ($this->recargo / 100.00);
    $this->total = $this->baseimponible + $this->cuotaiva + $this->cuotarecargo;
}