Database.interface.php

<?php
/* Copyright (C) 2001   Fabien Seisen     <seisen@linuxfr.org>
 * Copyright (C) 2002-2007  Rodolphe Quiedeville  <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2011  Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2006   Andre Cianfarani    <acianfa@free.fr>
 * Copyright (C) 2005-2012  Regis Houssin     <regis.houssin@inodbox.com>
 * Copyright (C) 2014-2015  Raphaël Doursenaud      <rdoursenaud@gpcsolutions.fr>
 * Copyright (C) 2024   MDW             <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024       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/>.
 */
 
interface Database
{
  public function ifsql($test, $resok, $resko);
 
  public function stddevpop($nameoffield);
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function fetch_row($resultset);
  // phpcs:enable
 
  public function idate($param, $gm = 'tzserver');
 
  public function lasterrno();
 
  public function begin($textinlog = '');
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLCreateDb($database, $charset = '', $collation = '', $owner = '');
  // phpcs:enable
 
  public function getVersionArray();
 
  public function convertSQLFromMysql($line, $type = 'ddl');
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function affected_rows($resultset);
  // phpcs:enable
 
  public function error();
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLListTables($database, $table = '');
  // phpcs:enable
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLListTablesFull($database, $table = '');
  // phpcs:enable
 
  public function lastquery();
 
  public function order($sortfield = '', $sortorder = '');
 
  public function decrypt($value);
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function fetch_array($resultset);
  // phpcs:enable
 
  public function lasterror();
 
  public function escape($stringtoencode);
 
  public function escapeforlike($stringtoencode);
 
  public function sanitize($stringtosanitize);
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function last_insert_id($tab, $fieldid = 'rowid');
  // phpcs:enable
 
  public function getPathOfRestore();
 
  public function rollback($log = '');
 
  public function query($query, $usesavepoint = 0, $type = 'auto', $result_mode = 0);
 
  public function connect($host, $login, $passwd, $name, $port = 0);
 
  public function plimit($limit = 0, $offset = 0);
 
  public function getServerParametersValues($filter = '');
 
  public function getServerStatusValues($filter = '');
 
  public function getDefaultCollationDatabase();
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function num_rows($resultset);
  // phpcs:enable
 
  public function getPathOfDump();
 
  public function getDriverInfo();
 
  public function errno();
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLCreateTable($table, $fields, $primary_key, $type, $unique_keys = null, $fulltext_keys = null, $keys = null);
  // phpcs:enable
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLDropTable($table);
  // phpcs:enable
 
  public function getListOfCharacterSet();
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLAddField($table, $field_name, $field_desc, $field_position = "");
  // phpcs:enable
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLDropField($table, $field_name);
  // phpcs:enable
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLUpdateField($table, $field_name, $field_desc);
  // phpcs:enable
 
  public function getListOfCollation();
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLDescTable($table, $field = "");
  // phpcs:enable
 
  public function getVersion();
 
  public function getDefaultCharacterSetDatabase();
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLCreateUser(
    $dolibarr_main_db_host,
    $dolibarr_main_db_user,
    $dolibarr_main_db_pass,
    $dolibarr_main_db_name
  );
  // phpcs:enable
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLInfoTable($table);
  // phpcs:enable
 
  public function jdate($string, $gm = false);
 
  public function encrypt($fieldorvalue, $withQuotes = 1);
 
  public function commit($log = '');
 
  public function free($resultset = null);
 
  public function close();
 
  public function lastqueryerror();
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function DDLGetConnectId();
  // phpcs:enable
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function fetch_object($resultset);
  // phpcs:enable
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function select_db($database);
  // phpcs:enable
}