Dolibarr\Code\Imports\Classes\ModeleImports

Complexity

Total Complexity

26

Size/Duplication

Total Lines	329
Duplicated Lines	0 %

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	getLibVersionForKey()	0	3	1
A	getDriverLabel()	0	3	1
A	getPictoForKey()	0	3	1
A	getDriverVersionForKey()	0	3	1
A	getDriverDescForKey()	0	3	1
A	getDriverId()	0	3	1
A	__construct()	0	11	5
A	getLibVersion()	0	3	1
A	getLibLabelForKey()	0	3	1
A	getDriverDesc()	0	3	1
B	listOfAvailableImportFormat()	0	36	6
A	getLibLabel()	0	3	1
A	getDriverLabelForKey()	0	3	1
A	getElementFromTableWithPrefix()	0	10	2
A	getDriverVersion()	0	3	1
A	getDriverExtension()	0	3	1

<?php

/* Copyright (C) 2005-2012  Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2005-2012	Regis Houssin		<regis.houssin@inodbox.com>
 * Copyright (C) 2024		MDW							<mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024       Frédéric France             <frederic.france@free.fr>
 * Copyright (C) 2024       Rafael San José             <rsanjose@alxarafe.com>
 *
 * 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/>.
 * or see https://www.gnu.org/
 */

namespace Dolibarr\Code\Imports\Classes;

use Dolibarr\Code\Societe\Classes\Societe;
use DoliDB;

/**
 *  \file       htdocs/core/modules/import/modules_import.php
 *  \ingroup    export
 *  \brief      File of parent class for import file readers
 */

require_once constant('DOL_DOCUMENT_ROOT') . '/core/lib/functions.lib.php';

/**
 *  Parent class for import file readers
 */
class ModeleImports
{
    /**
     * @var DoliDB Database handler.
     */
    public $db;

    public $datatoimport;

    /**
     * @var string Error code (or message)
     */
    public $error = '';

    /**
     * @var string[] Error codes (or messages)
     */
    public $errors = array();

    /**
     * @var string[] warnings codes (or messages)
     */
    public $warnings = array();

    /**
     * @var string Code of driver
     */
    public $id;

    /**
     * @var string label of driver
     */
    public $label;

    /**
     * @var string Extension of files imported by driver
     */
    public $extension;

    /**
     * Dolibarr version of driver
     * @var string
     */
    public $version = 'dolibarr';

    /**
     * PHP minimal version required by driver
     * @var array{0:int,1:int}
     */
    public $phpmin = array(7, 0);

    /**
     * Label of external lib used by driver
     * @var string
     */
    public $label_lib;

    /**
     * Version of external lib used by driver
     * @var string
     */
    public $version_lib;

    // Array of all drivers
    public $driverlabel = array();

    public $driverdesc = array();

    public $driverversion = array();

    public $drivererror = array();

    public $liblabel = array();

    public $libversion = array();

    /**
     * @var string charset
     */
    public $charset;

    /**
     * @var string picto
     */
    public $picto;

    /**
     * @var string description
     */
    public $desc;

    /**
     * @var string escape
     */
    public $escape;

    /**
     * @var string enclosure
     */
    public $enclosure;

    /**
     * @var Societe thirdparty
     */
    public $thirdpartyobject;

    /**
     * @var array   Element mapping from table name
     */
    public static $mapTableToElement = MODULE_MAPPING;

    /**
     *  Constructor
     */
    public function __construct()
    {
        global $hookmanager;

        if (is_object($hookmanager)) {
            $hookmanager->initHooks(array('import'));
            $parameters = array();
            $reshook = $hookmanager->executeHooks('constructModeleImports', $parameters, $this);
            if ($reshook >= 0 && !empty($hookmanager->resArray)) {
                foreach ($hookmanager->resArray as $mapList) {
                    self::$mapTableToElement[$mapList['table']] = $mapList['element'];
                }
            }
        }
    }

    /**
     * getDriverId
     *
     * @return string       Code of driver
     */
    public function getDriverId()
    {
        return $this->id;
    }

    /**
     *  getDriverLabel
     *
     * @return string  Label
     */
    public function getDriverLabel()
    {
        return $this->label;
    }

    /**
     *  getDriverDesc
     *
     * @return string  Description
     */
    public function getDriverDesc()
    {
        return $this->desc;
    }

    /**
     * getDriverExtension
     *
     * @return string   Driver suffix
     */
    public function getDriverExtension()
    {
        return $this->extension;
    }

    /**
     *  getDriverVersion
     *
     * @return string  Driver version
     */
    public function getDriverVersion()
    {
        return $this->version;
    }

    /**
     *  getDriverLabel
     *
     * @return string  Label of external lib
     */
    public function getLibLabel()
    {
        return $this->label_lib;
    }

    /**
     * getLibVersion
     *
     * @return string  Version of external lib
     */
    public function getLibVersion()
    {
        return $this->version_lib;
    }


    /**
     *  Load into memory list of available import format
     *
     * @param DoliDB $db Database handler
     * @param integer $maxfilenamelength Max length of value to show
     * @return array                       List of templates
     */
    public function listOfAvailableImportFormat($db, $maxfilenamelength = 0)
    {
        dol_syslog(get_class($this) . "::listOfAvailableImportFormat");

        $dir = DOL_DOCUMENT_ROOT . "/core/modules/import/";
        $handle = opendir($dir);

        // Search list ov drivers available and qualified
        if (is_resource($handle)) {
            while (($file = readdir($handle)) !== false) {
                $reg = array();
                if (preg_match("/^import_(.*)\.modules\.php/i", $file, $reg)) {
                    $moduleid = $reg[1];

                    // Loading Class
                    $file = $dir . "/import_" . $moduleid . ".modules.php";
                    $classname = "Import" . ucfirst($moduleid);

                    require_once $file;
                    $module = new $classname($db, '');

                    // Picto
                    $this->picto[$module->id] = $module->picto;
                    // Driver properties
                    $this->driverlabel[$module->id] = $module->getDriverLabel('');
                    $this->driverdesc[$module->id] = $module->getDriverDesc('');
                    $this->driverversion[$module->id] = $module->getDriverVersion('');
                    $this->drivererror[$module->id] = $module->error ? $module->error : '';
                    // If use an external lib
                    $this->liblabel[$module->id] = ($module->error ? '<span class="error">' . $module->error . '</span>' : $module->getLibLabel(''));
                    $this->libversion[$module->id] = $module->getLibVersion('');
                }
            }
        }

        return array_keys($this->driverlabel);
    }


    /**
     *  Return picto of import driver
     *
     * @param string $key Key
     * @return string
     */
    public function getPictoForKey($key)
    {
        return $this->picto[$key];
    }

    /**
     *  Return label of driver import
     *
     * @param string $key Key
     * @return string
     */
    public function getDriverLabelForKey($key)
    {
        return $this->driverlabel[$key];
    }

    /**
     *  Return description of import drivervoi la description d'un driver import
     *
     * @param string $key Key
     * @return string
     */
    public function getDriverDescForKey($key)
    {
        return $this->driverdesc[$key];
    }

    /**
     *  Renvoi version d'un driver import
     *
     * @param string $key Key
     * @return string
     */
    public function getDriverVersionForKey($key)
    {
        return $this->driverversion[$key];
    }

    /**
     *  Renvoi libelle de librairie externe du driver
     *
     * @param string $key Key
     * @return string
     */
    public function getLibLabelForKey($key)
    {
        return $this->liblabel[$key];
    }

    /**
     *  Renvoi version de librairie externe du driver
     *
     * @param string $key Key
     * @return string
     */
    public function getLibVersionForKey($key)
    {
        return $this->libversion[$key];
    }

    /**
     * Get element from table name with prefix
     *
     * @param string $tableNameWithPrefix Table name with prefix
     * @return  string  Element name or table element as default
     */
    public function getElementFromTableWithPrefix($tableNameWithPrefix)
    {
        $tableElement = preg_replace('/^' . preg_quote($this->db->prefix(), '/') . '/', '', $tableNameWithPrefix);
        $element = $tableElement;

        if (isset(self::$mapTableToElement[$tableElement])) {
            $element = self::$mapTableToElement[$tableElement];
        }

        return $element;
    }
}