extrafieldsinexport.inc.php

<?php
/* Copyright (C) 2024   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/>.
 */
'
@phan-var-force DolibarrModules $this
@phan-var-force int $r
';
 
// $keyforselect = name of main table
// keyforelement = name of picto
// $keyforaliasextra = a key to avoid conflict with extrafields of other objects
 
if (empty($keyforselect) || empty($keyforelement) || empty($keyforaliasextra)) {
  //print $keyforselet.' - '.$keyforelement.' - '.$keyforaliasextra;
  dol_print_error(null, 'include of file extrafieldsinexport.inc.php was done but var $keyforselect or $keyforelement or $keyforaliasextra was not set');
  exit;
}
 
// Add extra fields
// The list of extrafields for a given elementtype/entity is identical for every module that exports it,
// so it is cached for the duration of the request instead of being re-queried on each inclusion of this file
// (a page like user/perms.php that instantiates every module can otherwise trigger the same query dozens of times).
$cachekey = $keyforselect.'_'.$conf->entity;
if (!isset($conf->cache['extrafieldsinexport'][$cachekey])) {
  $sql = "SELECT name, label, type, param, fieldcomputed, fielddefault FROM ".MAIN_DB_PREFIX."extrafields";
  $sql .= " WHERE elementtype = '".$this->db->escape($keyforselect)."' AND type <> 'separate' AND entity IN (0, ".((int) $conf->entity).') ORDER BY pos ASC';
  //print $sql;
  $tmparrayextrafieldsinexport = array();
  $resql = $this->db->query($sql);
  if ($resql) {    // This can fail when class is used on old database (during migration for example)
    while ($obj = $this->db->fetch_object($resql)) {
      $tmparrayextrafieldsinexport[] = $obj;
    }
  }
  $conf->cache['extrafieldsinexport'][$cachekey] = $tmparrayextrafieldsinexport;
}
if (!empty($conf->cache['extrafieldsinexport'][$cachekey])) {
  foreach ($conf->cache['extrafieldsinexport'][$cachekey] as $obj) {
    '@phan-var-force stdClass $obj';
    $fieldname = $keyforaliasextra.'.'.$obj->name;
    $fieldlabel = ucfirst($obj->label);
    $typeFilter = "Text";
    $typefield = preg_replace('/\‍(.*$/', '', $obj->type); // double(24,8) -> double
    switch ($typefield) {
      case 'int':
      case 'integer':
      case 'double':
      case 'price':
        $typeFilter = "Numeric";
        break;
      case 'date':
      case 'datetime':
      case 'timestamp':
        $typeFilter = "Date";
        break;
      case 'boolean':
        $typeFilter = "Boolean";
        break;
      case 'checkbox':
      case 'select':
        if (getDolGlobalString('EXPORT_LABEL_FOR_SELECT')) {
          $tmpparam = jsonOrUnserialize($obj->param); // $tmpparam may be array with 'options' = array(key1=>val1, key2=>val2 ...)
          if ($tmpparam['options'] && is_array($tmpparam['options'])) {
            $typeFilter = "Select:".$obj->param;
          }
        }
        break;
      case 'sellist':
        $tmp = '';
        $tmpparam = jsonOrUnserialize($obj->param); // $tmp may be array 'options' => array 'c_currencies:code_iso:code_iso' => null
        if (is_array($tmpparam) && array_key_exists('options', $tmpparam) &&  $tmpparam['options'] && is_array($tmpparam['options'])) {
          $tmpkeys = array_keys($tmpparam['options']);
          $tmp = array_shift($tmpkeys);
        }
        if (preg_match('/[a-z0-9_]+:[a-z0-9_]+:[a-z0-9_]+/', (string) $tmp)) {
          $typeFilter = "List:".$tmp;
        }
        break;
    }
    if ($obj->type != 'separate') {
      // If not a computed field
      if (empty($obj->fieldcomputed)) {
        $this->export_fields_array[$r][$fieldname] = $fieldlabel;
        $this->export_TypeFields_array[$r][$fieldname] = $typeFilter;
        $this->export_entities_array[$r][$fieldname] = $keyforelement;
      } else {
        // If this is a computed field
        $this->export_fields_array[$r][$fieldname] = $fieldlabel;
        $this->export_TypeFields_array[$r][$fieldname] = $typeFilter.'Compute';
        $this->export_special_array[$r][$fieldname] = $obj->fieldcomputed;
        $this->export_entities_array[$r][$fieldname] = $keyforelement;
      }
    }
  }
}
// End add axtra fields