72 lines
1.8 KiB
PHP
72 lines
1.8 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* Copyright (c) 2013 Bart Visscher <bartv@thisnet.nl>
|
||
|
|
* This file is licensed under the Affero General Public License version 3 or
|
||
|
|
* later.
|
||
|
|
* See the COPYING-README file.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
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 $tableName the name of the table where we inserted the item
|
||
|
|
* @return int the id of the inserted element
|
||
|
|
*/
|
||
|
|
public function lastInsertId($table = null);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Insert a row if a matching row doesn't exists.
|
||
|
|
* @param $table string The table name (will replace *PREFIX*) to perform the replace on.
|
||
|
|
* @param $input array
|
||
|
|
*
|
||
|
|
* 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);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Start a transaction
|
||
|
|
*/
|
||
|
|
public function beginTransaction();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Commit the database changes done during a transaction that is in progress
|
||
|
|
*/
|
||
|
|
public function commit();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Rollback the database changes done during a transaction that is in progress
|
||
|
|
*/
|
||
|
|
public function rollBack();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* returns the error code and message as a string for logging
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getError();
|
||
|
|
}
|