diff options
author | Joas Schilling <nickvergessen@owncloud.com> | 2015-03-11 09:00:47 +0100 |
---|---|---|
committer | Joas Schilling <nickvergessen@owncloud.com> | 2015-03-11 09:05:30 +0100 |
commit | d1511cdbee24b27eb966eee334f3d686cbaec3d7 (patch) | |
tree | 328cea2f9be6c2f7b050f938364a2039d35e2a9b /lib/public | |
parent | 87431605b86674ec23c464c5a27b84c7771a2306 (diff) | |
download | nextcloud-server-d1511cdbee24b27eb966eee334f3d686cbaec3d7.tar.gz nextcloud-server-d1511cdbee24b27eb966eee334f3d686cbaec3d7.zip |
Fix doc blocks of insertIfNotExists() method
Diffstat (limited to 'lib/public')
-rw-r--r-- | lib/public/db.php | 22 | ||||
-rw-r--r-- | lib/public/idbconnection.php | 24 |
2 files changed, 16 insertions, 30 deletions
diff --git a/lib/public/db.php b/lib/public/db.php index d8d81f239b2..595ecd66bdc 100644 --- a/lib/public/db.php +++ b/lib/public/db.php @@ -48,23 +48,17 @@ class DB { } /** - * Insert a row if a matching row doesn't exists. - * @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix - * @param array $input - * - * The input array if in the form: + * Insert a row if the matching row does not exists. * - * array ( 'id' => array ( 'value' => 6, - * 'key' => true - * ), - * 'name' => array ('value' => 'Stoyan'), - * 'family' => array ('value' => 'Stefanov'), - * 'birth_date' => array ('value' => '1975-06-20') - * ); - * @return bool + * @param string $table The table name (will replace *PREFIX* with the actual prefix) + * @param array $input data that should be inserted into the table (column name => value) + * @param array|null $compare List of values that should be checked for "if not exists" + * If this is null or an empty array, all keys of $input will be compared + * @return int number of inserted rows + * @throws \Doctrine\DBAL\DBALException * */ - public static function insertIfNotExist($table, $input, $compare = null) { + public static function insertIfNotExist($table, $input, array $compare = null) { return \OC::$server->getDatabaseConnection()->insertIfNotExist($table, $input, $compare); } diff --git a/lib/public/idbconnection.php b/lib/public/idbconnection.php index c8a2c5796b5..1117c2da9b2 100644 --- a/lib/public/idbconnection.php +++ b/lib/public/idbconnection.php @@ -77,24 +77,16 @@ interface IDBConnection { 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 - * @throws \Doctrine\DBAL\DBALException - * - * 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 + * Insert a row if the matching row does not exists. * + * @param string $table The table name (will replace *PREFIX* with the actual prefix) + * @param array $input data that should be inserted into the table (column name => value) + * @param array|null $compare List of values that should be checked for "if not exists" + * If this is null or an empty array, all keys of $input will be compared + * @return int number of inserted rows + * @throws \Doctrine\DBAL\DBALException */ - public function insertIfNotExist($table, $input, $compare = null); + public function insertIfNotExist($table, $input, array $compare = null); /** * Start a transaction |