Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2025-01-10 20:44:43 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added documentation

Browse source
This commit is contained in:
Michael 2017-09-15 06:07:34 +00:00
parent cf90e3571f
commit 88ada98245
1 changed files with 35 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
include/dba.php
View file

@ -214,6 +214,16 @@ class dba {
} }
} }
/**
* @brief execute SQL query - deprecated
*
* Please use the dba:: functions instead:
* dba::select, dba::exists, dba::insert
* dba::delete, dba::update, dba::p, dba::e
*
* @param string $sql SQL query
* @return array Query array
*/
public function q($sql) { public function q($sql) {
$ret = self::p($sql); $ret = self::p($sql);
@ -366,6 +376,10 @@ class dba {
/** /**
* @brief Executes a prepared statement that returns data * @brief Executes a prepared statement that returns data
* @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid); * @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
*
* Please only use it with complicated queries.
* For all regular queries please use dba::select or dba::exists
*
* @param string $sql SQL statement * @param string $sql SQL statement
* @return object statement object * @return object statement object
*/ */
@ -574,6 +588,8 @@ class dba {
/** /**
* @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data * @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data
* *
* Please use dba::delete, dba::insert, dba::update, ... instead
*
* @param string $sql SQL statement * @param string $sql SQL statement
* @return boolean Was the query successfull? False is returned only if an error occurred * @return boolean Was the query successfull? False is returned only if an error occurred
*/ */
@ -656,6 +672,8 @@ class dba {
/** /**
* @brief Fetches the first row * @brief Fetches the first row
* *
* Please use dba::select or dba::select whenever this is possible.
*
* @param string $sql SQL statement * @param string $sql SQL statement
* @return array first row of query * @return array first row of query
*/ */
@ -1159,7 +1177,11 @@ class dba {
* Example: * Example:
* $table = "item"; * $table = "item";
* $fields = array("id", "uri", "uid", "network"); * $fields = array("id", "uri", "uid", "network");
*
* $condition = array("uid" => 1, "network" => 'dspr'); * $condition = array("uid" => 1, "network" => 'dspr');
* or:
* $condition = array("`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr');
*
* $params = array("order" => array("id", "received" => true), "limit" => 1); * $params = array("order" => array("id", "received" => true), "limit" => 1);
* *
* $data = dba::select($table, $fields, $condition, $params); * $data = dba::select($table, $fields, $condition, $params);
@ -1297,10 +1319,16 @@ function dbesc($str) {
} }
} }
// Function: q($sql,$args); /**
// Description: execute SQL query with printf style args. * @brief execute SQL query with printf style args - deprecated
// Example: $r = q("SELECT * FROM `%s` WHERE `uid` = %d", *
// 'user', 1); * Please use the dba:: functions instead:
* dba::select, dba::exists, dba::insert
* dba::delete, dba::update, dba::p, dba::e
*
* @param $args Query parameters (1 to N parameters of different types)
* @return array Query array
*/
function q($sql) { function q($sql) {
global $db; global $db;
@ -1336,10 +1364,9 @@ function q($sql) {
/** /**
* @brief Performs a query with "dirty reads" - deprecated * @brief Performs a query with "dirty reads" - deprecated
* *
* By doing dirty reads (reading uncommitted data) no locks are performed * Please use the dba:: functions instead:
* This function can be used to fetch data that doesn't need to be reliable. * dba::select, dba::exists, dba::insert
* * dba::delete, dba::update, dba::p, dba::e
* Hadn't worked like expected and does now the same like the other function.
* *
* @param $args Query parameters (1 to N parameters of different types) * @param $args Query parameters (1 to N parameters of different types)
* @return array Query array * @return array Query array