DoliDB.class.php

Go to the documentation of this file.

<?php
/*
 * Copyright (C) 2013-2015 Raphaël Doursenaud <rdoursenaud@gpcsolutions.fr>
 * Copyright (C) 2014-2015 Laurent Destailleur <eldy@users.sourceforge.net>
 *
 * 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/db/Database.interface.php';

abstract class DoliDB implements Database
{
  public $db;
  public $type;
  public $forcecharset = 'utf8';
  public $forcecollate = 'utf8_unicode_ci';
  private $_results;
  public $connected;
  public $database_selected;
  public $database_name;
  public $database_user;
  public $database_host;
  public $database_port;
  public $transaction_opened;
  public $lastquery;
  public $lastqueryerror;
  public $lasterror;
  public $lasterrno;

  public $ok;
  public $error;

  public function ifsql($test, $resok, $resko)
  {
    return 'IF('.$test.','.$resok.','.$resko.')';
  }

  public function idate($param, $gm = 'tzserver')
  {
    // TODO $param should be gmt, so we should add $gm to 'gmt' instead of default 'tzserver'
    return dol_print_date($param, "%Y-%m-%d %H:%M:%S", $gm);
  }

  public function lasterrno()
  {
    return $this->lasterrno;
  }

  public function sanitize($stringtosanitize, $allowsimplequote = 0)
  {
    if ($allowsimplequote) {
      return preg_replace('/[^a-z0-9_\-\.,\']/i', '', $stringtosanitize);
    } else {
      return preg_replace('/[^a-z0-9_\-\.,]/i', '', $stringtosanitize);
    }
  }

  public function begin()
  {
    if (!$this->transaction_opened)
    {
      $ret = $this->query("BEGIN");
      if ($ret)
      {
        $this->transaction_opened++;
        dol_syslog("BEGIN Transaction", LOG_DEBUG);
        dol_syslog('', 0, 1);
      }
      return $ret;
    } else {
      $this->transaction_opened++;
      dol_syslog('', 0, 1);
      return 1;
    }
  }

  public function commit($log = '')
  {
    dol_syslog('', 0, -1);
    if ($this->transaction_opened <= 1)
    {
      $ret = $this->query("COMMIT");
      if ($ret)
      {
        $this->transaction_opened = 0;
        dol_syslog("COMMIT Transaction".($log ? ' '.$log : ''), LOG_DEBUG);
        return 1;
      } else {
        return 0;
      }
    } else {
      $this->transaction_opened--;
      return 1;
    }
  }

  public function rollback($log = '')
  {
    dol_syslog('', 0, -1);
    if ($this->transaction_opened <= 1)
    {
      $ret = $this->query("ROLLBACK");
      $this->transaction_opened = 0;
      dol_syslog("ROLLBACK Transaction".($log ? ' '.$log : ''), LOG_DEBUG);
      return $ret;
    } else {
      $this->transaction_opened--;
      return 1;
    }
  }

  public function plimit($limit = 0, $offset = 0)
  {
    global $conf;
    if (empty($limit)) return "";
    if ($limit < 0) $limit = $conf->liste_limit;
    if ($offset > 0) return " LIMIT $offset,$limit ";
    else return " LIMIT $limit ";
  }

  public function getVersionArray()
  {
    return preg_split("/[\.,-]/", $this->getVersion());
  }

  public function lastquery()
  {
    return $this->lastquery;
  }

  public function order($sortfield = null, $sortorder = null)
  {
    if (!empty($sortfield))
    {
      $oldsortorder = '';
      $return = '';
      $fields = explode(',', $sortfield);
      $orders = explode(',', $sortorder);
      $i = 0;
      foreach ($fields as $val) {
        if (!$return) $return .= ' ORDER BY ';
        else $return .= ', ';

        $return .= preg_replace('/[^0-9a-z_\.]/i', '', $val); // Add field

        $tmpsortorder = (empty($orders[$i]) ? '' : trim($orders[$i]));

        // Only ASC and DESC values are valid SQL
        if (strtoupper($tmpsortorder) === 'ASC') {
          $oldsortorder = 'ASC';
          $return .= ' ASC';
        } elseif (strtoupper($tmpsortorder) === 'DESC') {
          $oldsortorder = 'DESC';
          $return .= ' DESC';
        } else {
          $return .= ' '.($oldsortorder ? $oldsortorder : 'ASC');
        }

        $i++;
      }
      return $return;
    } else {
      return '';
    }
  }

  public function lasterror()
  {
    return $this->lasterror;
  }

  public function jdate($string, $gm = 'tzserver')
  {
    // TODO $string should be converted into a GMT timestamp, so param gm should be set to true by default instead of false
    if ($string == 0 || $string == "0000-00-00 00:00:00") return '';
    $string = preg_replace('/([^0-9])/i', '', $string);
    $tmp = $string.'000000';
    $date = dol_mktime((int) substr($tmp, 8, 2), (int) substr($tmp, 10, 2), (int) substr($tmp, 12, 2), (int) substr($tmp, 4, 2), (int) substr($tmp, 6, 2), (int) substr($tmp, 0, 4), $gm);
    return $date;
  }

  public function lastqueryerror()
  {
    return $this->lastqueryerror;
  }

  public function getRow($sql)
  {
    $sql .= ' LIMIT 1;';

    $res = $this->query($sql);
    if ($res)
    {
      return $this->fetch_object($res);
    }

    return false;
  }

  public function getRows($sql)
  {
    $res = $this->query($sql);
    if ($res)
    {
      $results = array();
      if ($this->num_rows($res) > 0) {
        while ($obj = $this->fetch_object($res)) {
          $results[] = $obj;
        }
      }
      return $results;
    }

    return false;
  }
}