openstamanager/src/Importer/CSVImporter.php

155 lines
3.8 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;
use League\Csv\Reader;
/**
* Classe dedicata alla gestione dell'importazione da file CSV.
*
* @since 2.4.17
*/
abstract class CSVImporter implements ImporterInterface
{
protected $csv;
protected $column_associations;
protected $primary_key;
public function __construct($file)
{
// Impostazione automatica per i caratteri di fine riga
if (!ini_get('default_socket_timeout')) {
ini_set('default_socket_timeout', '0');
}
// Gestione del file CSV
$this->csv = Reader::createFromPath($file, 'r');
$this->csv->setDelimiter(';');
$this->column_associations = [];
}
public function init()
{
}
public function complete()
{
}
public function getColumnAssociations()
{
return $this->column_associations;
}
public function setColumnAssociation($column_key, $field_key)
{
$this->column_associations[$column_key] = $this->getAvailableFields()[$field_key]['field'];
}
abstract public function getAvailableFields();
public function getHeader()
{
$first_row = $this->getRows(0, 1);
return array_shift($first_row);
}
public function getRows($offset, $length)
{
$rows = [];
for ($i = 0; $i < $length; ++$i) {
// Lettura di una singola riga alla volta
$row = $this->csv->fetchOne($offset + $i);
if (empty($row)) {
break;
}
// Aggiunta all'insieme dei record
$rows[] = \Filter::parse($row);
}
return $rows;
}
public function importRows($offset, $length)
{
$rows = $this->getRows($offset, $length);
foreach ($rows as $row) {
// Interpretazione della riga come record
$record = $this->getRecord($row);
// Importazione del record
$this->import($record);
}
return count($rows);
}
abstract public function import($record);
public function getPrimaryKey()
{
return $this->primary_key;
}
public function setPrimaryKey($field_key)
{
$this->primary_key = $this->getAvailableFields()[$field_key]['field'];
}
public static function createExample($filepath)
{
$content = static::getExample();
$file = fopen($filepath, 'w');
fprintf($file, chr(0xEF).chr(0xBB).chr(0xBF));
foreach ($content as $row) {
fputcsv($file, $row, ';');
}
fclose($file);
}
/**
* Interpreta una riga del CSV secondo i campi impostati dinamicamente.
*
* @return array
*/
protected function getRecord($row)
{
$associations = $this->getColumnAssociations();
// Interpretazione della riga come record
$record = [];
foreach ($row as $key => $value) {
$field = $associations[$key] ?? null;
if (!empty($field)) {
$record[$field] = $value;
}
}
return $record;
}
}