From aa8a85f77d0c6705ee727d182e95d288ba7b7917 Mon Sep 17 00:00:00 2001 From: Bart Visscher Date: Fri, 20 Sep 2013 14:33:45 +0200 Subject: [PATCH] Add DBConnection to server container --- lib/db/connection.php | 2 +- lib/public/idbconnection.php | 71 +++++++++++++++++++++++++++++++++ lib/public/iservercontainer.php | 7 ++++ lib/server.php | 8 ++++ 4 files changed, 87 insertions(+), 1 deletion(-) create mode 100644 lib/public/idbconnection.php diff --git a/lib/db/connection.php b/lib/db/connection.php index 2581969dbd..2d3193a148 100644 --- a/lib/db/connection.php +++ b/lib/db/connection.php @@ -12,7 +12,7 @@ use Doctrine\DBAL\Configuration; use Doctrine\DBAL\Cache\QueryCacheProfile; use Doctrine\Common\EventManager; -class Connection extends \Doctrine\DBAL\Connection { +class Connection extends \Doctrine\DBAL\Connection implements \OCP\IDBConnection { /** * @var string $tablePrefix */ diff --git a/lib/public/idbconnection.php b/lib/public/idbconnection.php new file mode 100644 index 0000000000..67dd7ccfc3 --- /dev/null +++ b/lib/public/idbconnection.php @@ -0,0 +1,71 @@ + + * 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(); +} diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php index ad71427666..5481cd6ce6 100644 --- a/lib/public/iservercontainer.php +++ b/lib/public/iservercontainer.php @@ -83,4 +83,11 @@ interface IServerContainer { */ function getSession(); + /** + * Returns the current session + * + * @return \OCP\IDBConnection + */ + function getDatabaseConnection(); + } diff --git a/lib/server.php b/lib/server.php index 316ed39665..a5288fa148 100644 --- a/lib/server.php +++ b/lib/server.php @@ -170,4 +170,12 @@ class Server extends SimpleContainer implements IServerContainer { return \OC::$session; } + /** + * Returns the current session + * + * @return \OCP\IDBConnection + */ + function getDatabaseConnection() { + return \OC_DB::getConnection(); + } }