<?php
/**
 * Copyright 2017 Wim van Ravesteijn
*
* This file is part of AEGEE-Europe Statutory Event Applications.
*
* AEGEE-Europe Statutory Event Applications 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.
*
* AEGEE-Europe Statutory Event Applications 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 AEGEE-Europe Statutory Event Applications.  If not, see
* <http://www.gnu.org/licenses/>.
*/

interface IDB {
	/**
	 * Fetch a row from a table
	 *
	 * @param string $table
	 * @param int $id
	 * @return array associative array
	 */
	function fetchRow($table, $id);

	/**
	 * Select data
	 * 
	 * @param string $query
	 * @return IResult
	 */
	function select($query);
	
	/**
	 * Insert data into a table
	 * 
	 * @param string $table
	 * @param array $data
	 * @return int insertId, -1 in case of error
	 */
	function insert($table, $data);

	/**
	 * Update a record
	 * 
	 * @param string $table
	 * @param int $id
	 * @param array $data
	 * @param string $idField
	 * @return boolean true on success, false otherwise
	 */
	function update($table, $id, $data, $idField = "id");

	/**
	 * Delete data
	 * @param string $table
	 * @param int or array of int $ids
	 * @param string $idField
	 */
	function delete($table, $ids, $idField = "id");
	
	/**
	 * Flush privileges
	 */
	function flushPrivileges();
		
	/**
	 * Escape field for usage in select query. In case field contains a dot (.), it will be split and both sides will be escaped. May be an array
	 * 	of several fields
	 * 
	 * @param string $field
	 * @return string escaped field
	 */
	function escapeField($field);

	/**
	 * Escape value for usage in select query
	 *
	 * @param string $value
	 * @return string escaped value
	 */
	function escapeValue($value);
	
	/**
	 * Return the error generated by last query
	 * 
	 * @return string error
	 */
	function getLastError();
	
	/**
	 * Return the version number of the server
	 * 
	 * @return string server version
	 */
	function getServerVersion();
}
?>