Los modelos

En FacturaScripts los modelos cumplen una doble función, no sólo representan un objeto (como un producto) y permiten su creación, manipulación o eliminación de la base de datos, sino que además permiten obtener y filtrar otros objetos de la misma clase (en este caso más productos).

Un modelo es una clase que debe ir en un archivo con el mismo nombre y dentro de la carpeta Model del plugin.

Ejemplo: Project.php

Siguiendo con el ejemplo del plugin MyNewPlugin, vamos a añadirle un modelo llamado Project para dar de alta proyectos.

<?php
namespace FacturaScripts\Plugins\MyNewPlugin\Model;

use FacturaScripts\Core\Model\Base\ModelClass;
use FacturaScripts\Core\Model\Base\ModelTrait;

class Project extends ModelClass
{
    use ModelTrait;

    public $codproject;
    public $name;

    public static function primaryColumn(): string
    {
        return 'codproject';
    }

    public static function tableName(): string
    {
        return 'projects';
    }
}

namespace

Es importante recordar que nuestro plugin utiliza el espacio de nombres FacturaScripts\Plugins\MyNewPlugin, porque el plugin se llama MyNewPlugin. Si cambiamos este espacio de nombres dejará de funcionar. El espacio de nombres se debe corresponder con la carpeta donde está el archivo.

extends Base\ModelClass

Con esto estamos indicando que nuestra clase hereda de ModelClass, que es la clase base para los modelos de FacturaScripts. Podemos heredar de otra clase que no sea ModelClass, siempre y cuando esa otra clase herede de ModelClass.

use Base\ModelTrait

Esta línea es muy importante, indica que se use el trait ModelTrait, que es el que se encarga de leer los datos de la tabla y almacenar los campos en la variable fields. Es imprescindible que esta línea esté solamente en el modelo final, es decir, si va a heredar de otra clase que no sea ModelClass, no coloque el trait en esa clase, siempre debe ir en la última clase, en el modelo definitivo.

primaryColumn()

Esta función debe devolver el nombre de la columna de la clave primaria de la tabla.

tableName()

Debe devolver el nombre de la tabla de la base de datos que utiliza este modelo. FacturaScripts buscará a continuación el archivo con la definición de la estructura de la tabla. Puede ver más detalles en los enlaces más abajo.

Buenas prácticas para la elección de nombres

El nombre del modelo debe ser siempre en singular y el de la tabla en plural. Si necesita un modelo para edificios, el modelo se debería llamar Edificio y la tabla edificios.

Nombres de columna conflictivos

Evite usar en sus columnas nombres como: action y code.

Herencia de modelos

Puede heredar y personalizar cualquier modelo existente, pero recuerde que debe utilizar un alias antes de heredar. Aquí tiene un ejemplo:

<?php
namespace FacturaScripts\Plugins\MyNewPlugin\Model;

use FacturaScripts\Core\Model\Cliente as ParentModel;

class Cliente extends ParentModel {
}

Fíjese en la línea 'use FacturaScripts\Core\Model\Cliente as ParentModel;'. Ese as es para utilizar Cliente con el alias de ParentModel. Si no usa un alias tendrá una colisión de nombres al definir la nueva clase, ya que esta se llama igual que la clase de la que deseea heredar.