mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix doc blocks of insertIfNotExists() method

This commit is contained in:
Joas Schilling 2015-03-11 09:00:47 +01:00
parent 87431605b8
commit d1511cdbee
6 changed files with 48 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
lib/private/appframework/db/db.php
View File

@ -121,24 +121,16 @@ class Db implements IDb {
}
/**
* 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 \OC\HintException
*
* 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) {
return $this->connection->insertIfNotExist($table, $input, $compare);
}

13
lib/private/db/adapter.php
View File

@ -40,13 +40,16 @@ class Adapter {
}
/**
* insert the @input values when they do not exist yet
* @param string $table name
* @param array $input key->value pair, key has to be sanitized properly
* 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
* @return int count of inserted rows
*/
public function insertIfNotExist($table, $input, $compare = null) {
public function insertIfNotExist($table, $input, array $compare = null) {
if ($compare === null) {
$compare = array_keys($input);
}

13
lib/private/db/adaptersqlite.php
View File

@ -19,13 +19,16 @@ class AdapterSqlite extends Adapter {
}
/**
* @param string $table
* @param array $input
* @param null $compare
* @return int
* 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) {
if ($compare === null) {
$compare = array_keys($input);
}

14
lib/private/db/connection.php
View File

@ -157,14 +157,16 @@ class Connection extends \Doctrine\DBAL\Connection implements IDBConnection {
}
/**
* Insert a row if a matching row does not exists.
* @param string $table. The table to insert into in the form '*PREFIX*tableName'
* @param array $input. An array of field name/value pairs
* @param array $compare
* 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
* @return bool The return value from execute()
*/
public function insertIfNotExist($table, $input, $compare = null) {
public function insertIfNotExist($table, $input, array $compare = null) {
return $this->adapter->insertIfNotExist($table, $input, $compare);
}

22
lib/public/db.php
View File

@ -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
* Insert a row if the matching row does not exists.
*
* 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
* @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);
}

24
lib/public/idbconnection.php
View File

@ -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
* 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
*
* 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, $compare = null);
public function insertIfNotExist($table, $input, array $compare = null);
/**
* Start a transaction