From 3eb5fff02a477fbb3bd4080a4eb4e773e8db5d1f Mon Sep 17 00:00:00 2001
From: Bart Visscher <bartv@thisnet.nl>
Date: Tue, 23 Jul 2013 18:09:38 +0200
Subject: [PATCH] Add documentation to OC\DB\adapter class

---
 lib/db/adapter.php | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/lib/db/adapter.php b/lib/db/adapter.php
index 20e7ea4a600..2e4f230f366 100644
--- a/lib/db/adapter.php
+++ b/lib/db/adapter.php
@@ -8,6 +8,10 @@
 
 namespace OC\DB;
 
+/**
+ * This handles the way we use to write queries, into something that can be
+ * handled by the database abstraction layer.
+ */
 class Adapter {
 	protected $conn;
 
@@ -15,14 +19,28 @@ class Adapter {
 		$this->conn = $conn;
 	}
 
+	/**
+	 * @param string $table name
+	 * @return int id of last insert statement
+	 */
 	public function lastInsertId($table) {
 		return $this->conn->realLastInsertId($table);
 	}
 
+	/**
+	 * @param $statement that needs to be changed so the db can handle it
+	 * @return string changed statement
+	 */
 	public function fixupStatement($statement) {
 		return $statement;
 	}
 
+	/**
+	 * @brief insert the @input values when they do not exist yet
+	 * @param string $table name
+	 * @param array key->value pairs 
+	 * @return count of inserted rows
+	 */
 	public function insertIfNotExist($table, $input) {
 		$query = 'INSERT INTO `' .$table . '` (`'
 			. implode('`,`', array_keys($input)) . '`) SELECT '
-- 
2.39.5