Como añadir una plantilla manual a CSVimport

Las plantillas manuales son aquellas podremos seleccionar al momento de cargar un archivo csv, solo aparecerán si estamos en la pantalla correcta, por ejmeplo, si creamos una plantilla manual para el modelo clientes, solo aparecerá dicha opción al importar clientes.

Ejemplo de como añadir la plantilla manual al archivo init.php del plugin.

<?php

namespace FacturaScripts\Plugins\MyPlugin;

use FacturaScripts\Core\Template\InitClass;
use FacturaScripts\Dinamic\Lib\ManualTemplates\Customers;
use FacturaScripts\Dinamic\Model\CSVfile;

final class Init extends InitClass
{
    public function init(): void
    {
        CSVfile::addManualTemplate('customers', new Customers());
    }
}

Ejemplo de como implementar nuestra clase manual Customers, dicha clase tendrá que implementar la clase ManualTemplateInterface y heredar de ManualTemplateClass.

<?php

namespace FacturaScripts\Plugins\MyPlugin\Lib\ManualTemplates;

use FacturaScripts\Dinamic\Model\Cliente;
use FacturaScripts\Plugins\CSVimport\Contract\ManualTemplateInterface;
use FacturaScripts\Plugins\CSVimport\Lib\ManualTemplateClass\ManualTemplateClass;
use FacturaScripts\Plugins\CSVimport\Lib\CsvFileTools;

class Customers extends ManualTemplateClass implements ManualTemplateInterface
{
    /**
    * Aquí especificaremos todas las columnas disponibles que el usuario podrá seleccionar para vincular en su csv
    */
    public function getDataFields(): array
    {
        return [
            'codcliente' => ['title' => 'customer-code'],
            'nombre' => ['title' => 'name'],
            'razonsocial' => ['title' => 'business-name'],
            'cifnif' => ['title' => 'cifnif'],
            'telefono1' => ['title' => 'phone'],
        ];
    }

    /**
    * Aquí podemos indicar si alguna de las columnas anteriores va relacionada con alguna columnas del modelo, en este caso el modelo de Clientes. Es necesario por ejemplo para cargar los productos de un provoeedor, previamente necesitamos el código del proveedor y saber en que columna del modelo va ese código, si no, no poredemos importar los proveedores.
    */
    public function getFieldsToColumn(): array
    {
        return [];
    }

    /**
    * Srive para obtener a que perfil pertenece esta clase de importación, debe ser igual a lo que pongamos en el archivo init
    */
    public static function getProfile(): string
    {
        return 'customers';
    }

    /**
    * Aquí podemos indicar que columnas del modelo son obligatorias, por ejemplo, las columnas "nombre" y "cifnif", sin ella no se puede importar nada. Las columnas son combinadas, osea si por ejemplo hemos peusto dos columnas, las dos tendrán que estar rellenadas.
    */
    public function getRequiredFieldsAnd(): array
    {
        return ['nombre', 'cifnif'];
    }

    /**
    * Parecido al anterior pero usando la clave "OR", quiere decir que es obligatoria rellenar una de las columnas, por ejemplo, rellenar el "cifnif" o "razonsocial".
    */
    public function getRequiredFieldsOr(): array
    {
        return ['razonsocial', 'cifnif'];
    }

    /**
    * Aqui es donde haremos la comprobación de los datos y guardaremos
    */
    public function importItem(array $item): bool
    {
        $where = [];
        if (isset($item['clientes.codcliente']) && !empty($item['clientes.codcliente'])) {
            $where[] = new DataBaseWhere('codcliente', $item['clientes.codcliente']);
        } elseif (isset($item['clientes.nombre']) && !empty($item['clientes.nombre'])) {
            $where[] = new DataBaseWhere('nombre', $item['clientes.nombre']);
        } elseif (isset($item['clientes.cifnif']) && !empty($item['clientes.cifnif'])) {
            $where[] = new DataBaseWhere('cifnif', $item['clientes.cifnif']);
        }

        if (empty($where)) {
            return false;
        }

        $customer = new Cliente();
        if ($customer->loadFromCode('', $where) && $this->model->mode === CsvFileTools::INSERT_MODE ||
            false === $customer->loadFromCode('', $where) && $this->model->mode === CsvFileTools::UPDATE_MODE) {
                return false;
        }

        if (false === $this->setModelValues($customer, $item, 'clientes.')) {
            return false;
        }

        return $customer->save();
    }
}