openstamanager/src/Importer/ImporterInterface.php

124 lines
3.0 KiB
PHP

<?php
/*
* OpenSTAManager: il software gestionale open source per l'assistenza tecnica e la fatturazione
* Copyright (C) DevCode s.r.l.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
namespace Importer;
/**
* Interfaccia che definisce la struttura di base per la gestione delle importazioni di documenti come dati del gestionale.
*
* @since 2.4.17
*/
interface ImporterInterface
{
/**
* Esegue le operazioni di inizializzazione per la procedura di importazione.
*
* @return mixed
*/
public function init();
/**
* Esegue le operazioni di finalizazione per la procedura di importazione.
*
* @return mixed
*/
public function complete();
/**
* Restituisce le associazioni impostate tra colonne e campi del documento.
*
* @return mixed
*/
public function getColumnAssociations();
/**
* Imposta l'associazione di una specifica colonna del documento al relativo campo del documento.
*
* @param $column_key
* @param $field_key
*
* @return mixed
*/
public function setColumnAssociation($column_key, $field_key);
/**
* Restitusice i campi disponibili all'importazione.
*
* @return mixed
*/
public function getAvailableFields();
/**
* Restituisce l'header (potenziale) per il documento da importare.
*
* @return mixed
*/
public function getHeader();
/**
* Restituisce un sottoinsieme delle righe del documento.
*
* @param $offset
* @param $length
*
* @return array
*/
public function getRows($offset, $length);
/**
* Importa un sottoinsieme delle righe del documento nel gestionale.
*
* @param $offset
* @param $length
*
* @return int
*/
public function importRows($offset, $length);
/**
* Gestisce le operazioni di importazione per un singolo record.
*
* @param $record
*
* @return bool
*/
public function import($record);
/**
* Restituisce la chiave primaria impostata dall'utente.
*
* @return mixed
*/
public function getPrimaryKey();
/**
* Imposta la chiave primaria selezionata dall'utente.
*
* @param $field_key
*/
public function setPrimaryKey($field_key);
/**
* Restituisce un esempio di dato importabile.
*
* @return array
*/
public static function getExample();
}