7644950b48
* enhance the app development experience - you can look up the method introduction right inside the code without searching via git blame * easier to write apps for multiple versions
136 lines
4 KiB
PHP
136 lines
4 KiB
PHP
<?php
|
|
/**
|
|
* @author Bart Visscher <bartv@thisnet.nl>
|
|
* @author Dan Bartram <daneybartram@gmail.com>
|
|
* @author Felix Moeller <mail@felixmoeller.de>
|
|
* @author Frank Karlitschek <frank@owncloud.org>
|
|
* @author Joas Schilling <nickvergessen@owncloud.com>
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
* @author Robin Appelman <icewind@owncloud.com>
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
* @author Thomas Tanghus <thomas@tanghus.net>
|
|
*
|
|
* @copyright Copyright (c) 2015, ownCloud, Inc.
|
|
* @license AGPL-3.0
|
|
*
|
|
* This code is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License, version 3,
|
|
* as published by the Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License, version 3,
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Public interface of ownCloud for apps to use.
|
|
* DB Class
|
|
*
|
|
*/
|
|
|
|
// use OCP namespace for all classes that are considered public.
|
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
|
namespace OCP;
|
|
|
|
/**
|
|
* This class provides access to the internal database system. Use this class exlusively if you want to access databases
|
|
* @since 4.5.0
|
|
*/
|
|
class DB {
|
|
/**
|
|
* Prepare a SQL query
|
|
* @param string $query Query string
|
|
* @param int $limit Limit of the SQL statement
|
|
* @param int $offset Offset of the SQL statement
|
|
* @return \OC_DB_StatementWrapper prepared SQL query
|
|
*
|
|
* SQL query via Doctrine prepare(), needs to be execute()'d!
|
|
* @since 4.5.0
|
|
*/
|
|
static public function prepare( $query, $limit=null, $offset=null ) {
|
|
return(\OC_DB::prepare($query, $limit, $offset));
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
* @since 5.0.0 - parameter $compare was added in 8.1.0
|
|
*
|
|
*/
|
|
public static function insertIfNotExist($table, $input, array $compare = null) {
|
|
return \OC::$server->getDatabaseConnection()->insertIfNotExist($table, $input, $compare);
|
|
}
|
|
|
|
/**
|
|
* Gets last value of autoincrement
|
|
* @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix
|
|
* @return string
|
|
*
|
|
* \Doctrine\DBAL\Connection lastInsertID()
|
|
*
|
|
* Call this method right after the insert command or other functions may
|
|
* cause trouble!
|
|
* @since 4.5.0
|
|
*/
|
|
public static function insertid($table=null) {
|
|
return(\OC_DB::insertid($table));
|
|
}
|
|
|
|
/**
|
|
* Start a transaction
|
|
* @since 4.5.0
|
|
*/
|
|
public static function beginTransaction() {
|
|
\OC_DB::beginTransaction();
|
|
}
|
|
|
|
/**
|
|
* Commit the database changes done during a transaction that is in progress
|
|
* @since 4.5.0
|
|
*/
|
|
public static function commit() {
|
|
\OC_DB::commit();
|
|
}
|
|
|
|
/**
|
|
* Rollback the database changes done during a transaction that is in progress
|
|
* @since 8.0.0
|
|
*/
|
|
public static function rollback() {
|
|
\OC_DB::rollback();
|
|
}
|
|
|
|
/**
|
|
* Check if a result is an error, works with Doctrine
|
|
* @param mixed $result
|
|
* @return bool
|
|
* @since 4.5.0
|
|
*/
|
|
public static function isError($result) {
|
|
return(\OC_DB::isError($result));
|
|
}
|
|
|
|
/**
|
|
* returns the error code and message as a string for logging
|
|
* works with DoctrineException
|
|
* @param mixed $error
|
|
* @return string
|
|
* @since 6.0.0
|
|
*/
|
|
public static function getErrorMessage($error) {
|
|
return(\OC_DB::getErrorMessage($error));
|
|
}
|
|
|
|
}
|