modules_export.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2005      Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2005-2007 Regis Houssin        <regis.houssin@inodbox.com>
 * Copyright (C) 2024-2025  MDW             <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2025       Frédéric France         <frederic.france@free.fr>
 *
 * 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/>.
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php';
 
 
class ModeleExports extends CommonDocGenerator    // This class can't be abstract as there is instance properties loaded by listOfAvailableExportFormat
{
  public $id = 'NOT IMPLEMENTED';
 
  public $error = '';
 
  public $driverlabel = array();
 
  public $driverdesc = array();
 
  public $driverversion = array();
 
  public $liblabel = array();
 
  public $libversion = array();
 
  public $picto;
 
  public $pictos;
 
  public $desc;
 
  public $escape;
 
  public $enclosure;
 
  public $separator;
 
  public $col;
 
  public $disabled;
 
  public function listOfAvailableExportFormat($db, $maxfilenamelength = 0)
  {
    global $langs;
 
    dol_syslog(get_class($this)."::listOfAvailableExportFormat");
 
    $dir = DOL_DOCUMENT_ROOT."/core/modules/export/";
    $handle = opendir($dir);
 
    // Recherche des fichiers drivers exports disponibles
    $i = 0;
    if (is_resource($handle)) {
      while (($file = readdir($handle)) !== false) {
        $reg = array();
        if (preg_match("/^export_(.*)\.modules\.php$/i", $file, $reg)) {
          $moduleid = $reg[1];
          if ($moduleid == 'csv') {
            continue; // This may happen if on old file export_csv.modules.php was not correctly deleted
          }
 
          // Loading Class
          $file = $dir."export_".$moduleid.".modules.php";
          $classname = "Export".ucfirst($moduleid);
 
          require_once $file;
          if (class_exists($classname)) {
            $module = new $classname($db);
            '@phan-var-force ModeleExports $module';
            // var_dump($classname);
 
            // Picto
            $this->pictos[$module->id] = $module->picto;
            // Driver properties
            $this->driverlabel[$module->id] = $module->getDriverLabel().(empty($module->disabled) ? '' : ' __(Disabled)__'); // '__(Disabled)__' is a key
            if (method_exists($module, 'getDriverLabelBis')) {
              // @phan-suppress-next-line PhanUndeclaredMethod
              $labelBis = $module->getDriverLabelBis();
              if ($labelBis) {
                $this->driverlabel[$module->id] .= ' <span class="opacitymedium">('.$labelBis.')</span>';
              }
            }
            $this->driverdesc[$module->id] = $module->getDriverDesc();
            $this->driverversion[$module->id] = $module->getDriverVersion();
            // If use an external lib
            $this->liblabel[$module->id] = $module->getLibLabel();
            $this->libversion[$module->id] = $module->getLibVersion();
          }
          $i++;
        }
      }
      closedir($handle);
    }
 
    asort($this->driverlabel);
 
    return $this->driverlabel;
  }
 
 
  public function getPictoForKey($key)
  {
    return $this->pictos[$key];
  }
 
  public function getDriverLabelForKey($key)
  {
    return $this->driverlabel[$key];
  }
 
  public function getDriverDescForKey($key)
  {
    return $this->driverdesc[$key];
  }
 
  public function getDriverVersionForKey($key)
  {
    return $this->driverversion[$key];
  }
 
  public function getLibLabelForKey($key)
  {
    return $this->liblabel[$key];
  }
 
  public function getLibVersionForKey($key)
  {
    // phpcs:enable
    return $this->libversion[$key];
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_record($array_selected_sorted, $objp, $outputlangs, $array_types)
  {
    // phpcs:enable
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->error = $msg;
    return -1;
  }
 
 
  public function getDriverLabel()
  {
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->error = $msg;
    return 'Not implemented';
  }
 
  public function getDriverDesc()
  {
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->error = $msg;
    return 'Not implemented';
  }
 
  public function getDriverVersion()
  {
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->error = $msg;
    return 'Not implemented';
  }
 
  public function getLibLabel()
  {
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->error = $msg;
    return 'Not implemented';
  }
 
  public function getLibVersion()
  {
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->error = $msg;
    return 'Not implemented';
  }
 
  public function getDriverExtension()
  {
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->error = $msg;
    return 'Not implemented';
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function open_file($file, $outputlangs)
  {
    // phpcs:enable
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->error = $msg;
    return -1;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_header($outputlangs)
  {
    // phpcs:enable
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->error = $msg;
    return -1;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_title($array_export_fields_label, $array_selected_sorted, $outputlangs, $array_types)
  {
    // phpcs:enable
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->error = $msg;
    return -1;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function write_footer($outputlangs)
  {
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->error = $msg;
    return -1;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function close_file()
  {
    $msg = get_class($this)."::".__FUNCTION__." not implemented";
    dol_syslog($msg, LOG_ERR);
    $this->error = $msg;
    return -1;
  }
}