defaultvalues.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2017  Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2021  Florian HENRY <florian.henry@scopen.fr>
 * Copyright (C) 2021   Frédéric France     <frederic.france@netlogic.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/>.
 */
 
// Put here all includes required by your class file
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
//require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php';
//require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
 
class DefaultValues extends CommonObject
{
  public $element = 'defaultvalues';
 
  public $table_element = 'default_values';
 
  public $ismultientitymanaged = 1;
 
  public $isextrafieldmanaged = 0;
 
  public $picto = '';
 
  // BEGIN MODULEBUILDER PROPERTIES
  public $fields = array(
    'rowid' =>array('type'=>'integer', 'label'=>'TechnicalID', 'enabled'=>1, 'visible'=>-1, 'notnull'=>1, 'position'=>10),
    'entity' =>array('type'=>'integer', 'label'=>'Entity', 'default'=>1, 'enabled'=>1, 'visible'=>-2, 'notnull'=>1, 'position'=>15, 'index'=>1),
    'type' =>array('type'=>'varchar(10)', 'label'=>'Type', 'enabled'=>1, 'visible'=>-1, 'position'=>20),
    'user_id' =>array('type'=>'integer', 'label'=>'Userid', 'enabled'=>1, 'visible'=>-1, 'notnull'=>1, 'position'=>25),
    'page' =>array('type'=>'varchar(255)', 'label'=>'RelativeURL', 'enabled'=>1, 'visible'=>-1, 'position'=>30),
    'param' =>array('type'=>'varchar(255)', 'label'=>'Field', 'enabled'=>1, 'visible'=>-1, 'position'=>35),
    'value' =>array('type'=>'varchar(128)', 'label'=>'Value', 'enabled'=>1, 'visible'=>-1, 'position'=>40),
  );
 
  public $rowid;
 
  public $entity;
 
  public $type;
 
  public $user_id;
 
  public $page;
 
  public $param;
 
  public $value;
  // END MODULEBUILDER PROPERTIES
 
  public function __construct(DoliDB $db)
  {
    global $conf, $langs;
 
    $this->db = $db;
 
    if (empty($conf->global->MAIN_SHOW_TECHNICAL_ID) && isset($this->fields['rowid'])) {
      $this->fields['rowid']['visible'] = 0;
    }
    if (!isModEnabled('multicompany') && isset($this->fields['entity'])) {
      $this->fields['entity']['enabled'] = 0;
    }
 
    // Unset fields that are disabled
    foreach ($this->fields as $key => $val) {
      if (isset($val['enabled']) && empty($val['enabled'])) {
        unset($this->fields[$key]);
      }
    }
 
    // Translate some data of arrayofkeyval
    if (is_object($langs)) {
      foreach ($this->fields as $key => $val) {
        if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
          foreach ($val['arrayofkeyval'] as $key2 => $val2) {
            $this->fields[$key]['arrayofkeyval'][$key2] = $langs->trans($val2);
          }
        }
      }
    }
  }
 
  public function create(User $user, $notrigger = false)
  {
    return $this->createCommon($user, $notrigger);
  }
 
  public function createFromClone(User $user, $fromid)
  {
    global $langs, $extrafields;
    $error = 0;
 
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $object = new self($this->db);
 
    $this->db->begin();
 
    // Load source object
    $result = $object->fetchCommon($fromid);
 
    // Reset some properties
    unset($object->id);
 
    // Create clone
    $object->context['createfromclone'] = 'createfromclone';
    $result = $object->createCommon($user);
    if ($result < 0) {
      $error++;
      $this->error = $object->error;
      $this->errors = $object->errors;
    }
 
    unset($object->context['createfromclone']);
 
    // End
    if (!$error) {
      $this->db->commit();
      return $object;
    } else {
      $this->db->rollback();
      return -1;
    }
  }
 
  public function fetch($id)
  {
    $result = $this->fetchCommon($id, null);
    return $result;
  }
 
  public function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, array $filter = array(), $filtermode = 'AND')
  {
    global $conf;
 
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $records = array();
 
    $sql = "SELECT ";
    $sql .= $this->getFieldList();
    $sql .= " FROM ".$this->db->prefix().$this->table_element." as t";
    $sql .= " WHERE 1 = 1";
    // Manage filter
    $sqlwhere = array();
    if (count($filter) > 0) {
      foreach ($filter as $key => $value) {
        if ($key == 't.rowid' || ($key == 't.entity' && !is_array($value)) || ($key == 't.user_id' && !is_array($value))) {
          $sqlwhere[] = $key." = ".((int) $value);
        } elseif (isset($this->fields[$key]) && in_array($this->fields[$key]['type'], array('date', 'datetime', 'timestamp'))) {
          $sqlwhere[] = $key." = '".$this->db->idate($value)."'";
        } elseif ($key == 't.page' || $key == 't.param' || $key == 't.type') {
          $sqlwhere[] = $key." = '".$this->db->escape($value)."'";
        } elseif ($key == 'customsql') {
          $sqlwhere[] = $value;
        } elseif (is_array($value)) {
          $sqlwhere[] = $key." IN (".$this->db->sanitize(implode(',', $value)).")";
        } else {
          $sqlwhere[] = $key." LIKE '%".$this->db->escape($value)."%'";
        }
      }
    }
    if (count($sqlwhere) > 0) {
      $sql .= ' AND ('.implode(' '.$this->db->escape($filtermode).' ', $sqlwhere).')';
    }
 
    if (!empty($sortfield)) {
      $sql .= $this->db->order($sortfield, $sortorder);
    }
    if (!empty($limit)) {
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $resql = $this->db->query($sql);
    if ($resql) {
      $num = $this->db->num_rows($resql);
      $i = 0;
      while ($i < ($limit ? min($limit, $num) : $num)) {
        $obj = $this->db->fetch_object($resql);
 
        $record = new self($this->db);
        $record->setVarsFromFetchObj($obj);
 
        $records[$record->id] = $record;
 
        $i++;
      }
      $this->db->free($resql);
 
      return $records;
    } else {
      $this->errors[] = 'Error '.$this->db->lasterror();
      dol_syslog(__METHOD__.' '.join(',', $this->errors), LOG_ERR);
 
      return -1;
    }
  }
 
  public function update(User $user, $notrigger = false)
  {
    return $this->updateCommon($user, $notrigger);
  }
 
  public function delete(User $user, $notrigger = false)
  {
    return $this->deleteCommon($user, $notrigger);
  }
 
  public function initAsSpecimen()
  {
    $this->initAsSpecimenCommon();
  }
}