<?php
  /**
   * ownCloud
   *
   * @author Bart Visscher
   * @copyright 2013 Bart Visscher bartv@thisnet.nl
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
   * License as published by the Free Software Foundation; either
   * version 3 of the License, or any later version.
   *
   * This library 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 AFFERO GENERAL PUBLIC LICENSE for more details.
   *
   * You should have received a copy of the GNU Affero General Public
   * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
   *
   */
  
  /**
   * Public interface of ownCloud for apps to use.
   * DBConnection interface
   *
   */
  
  // use OCP namespace for all classes that are considered public.
  // This means that they should be used by apps instead of the internal ownCloud classes
  namespace OCP;
  
  /**
   * TODO: Description
   */
  interface IDBConnection {
  	/**
  	 * Used to abstract the owncloud database access away
  	 * @param string $sql the sql query with ? placeholder for params
  	 * @param int $limit the maximum number of rows
  	 * @param int $offset from which row we want to start
  	 * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
  	 */
  	public function prepare($sql, $limit=null, $offset=null);
  
  	/**
  	 * Used to get the id of the just inserted element
  	 * @param string $table the name of the table where we inserted the item
  	 * @return int the id of the inserted element
  	 */
  	public function lastInsertId($table = null);
  
  	/**
  	 * Insert a row if a matching row doesn't exists.

  	 * @param string $table The table name (will replace *PREFIX*) to perform the replace on.
  	 * @param array $input

  	 *
  	 * The input array if in the form:
  	 *
  	 * array ( 'id' => array ( 'value' => 6,
  	 *	'key' => true
  	 *	),
  	 *	'name' => array ('value' => 'Stoyan'),
  	 *	'family' => array ('value' => 'Stefanov'),
  	 *	'birth_date' => array ('value' => '1975-06-20')
  	 *	);
  	 * @return bool
  	 *
  	 */
  	public function insertIfNotExist($table, $input);
  
  	/**
  	 * Start a transaction
  	 * @return bool TRUE on success or FALSE on failure
  	 */
  	public function beginTransaction();
  
  	/**
  	 * Commit the database changes done during a transaction that is in progress
  	 * @return bool TRUE on success or FALSE on failure
  	 */
  	public function commit();
  
  	/**
  	 * Rollback the database changes done during a transaction that is in progress
  	 * @return bool TRUE on success or FALSE on failure
  	 */
  	public function rollBack();
  
  	/**
  	 * Gets the error code and message as a string for logging
  	 * @return string
  	 */
  	public function getError();
  }