}
/**
- * @brief Returns the MySQL server version string
+ * Returns the MySQL server version string
*
* This function discriminate between the deprecated mysql API and the current
* object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
}
/**
- * @brief Returns the selected database name
+ * Returns the selected database name
*
* @return string
* @throws \Exception
return DI::dba()->databaseName();
}
+ /**
+ * Escape all SQL unsafe data
+ *
+ * @param string $str
+ * @return string escaped string
+ */
public static function escape($str)
{
return DI::dba()->escape($str);
}
+ /**
+ * Checks if the database is connected
+ *
+ * @return boolean is the database connected?
+ */
public static function connected()
{
return DI::dba()->connected();
}
/**
- * @brief Replaces ANY_VALUE() function by MIN() function,
- * if the database server does not support ANY_VALUE().
+ * Replaces ANY_VALUE() function by MIN() function,
+ * if the database server does not support ANY_VALUE().
*
* Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5).
* ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html
}
/**
- * @brief beautifies the query - useful for "SHOW PROCESSLIST"
+ * beautifies the query - useful for "SHOW PROCESSLIST"
*
* This is safe when we bind the parameters later.
* The parameter values aren't part of the SQL.
}
/**
- * @brief Convert parameter array to an universal form
+ * Convert parameter array to an universal form
* @param array $args Parameter array
* @return array universalized parameter array
*/
}
/**
- * @brief Executes a prepared statement that returns data
- * @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
+ * Executes a prepared statement that returns data
+ * 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
}
/**
- * @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data
+ * Executes a prepared statement like UPDATE or INSERT that doesn't return data
*
* Please use DBA::delete, DBA::insert, DBA::update, ... instead
*
}
/**
- * @brief Check if data exists
+ * Check if data exists
*
* @param string|array $table Table name or array [schema => table]
* @param array $condition array of fields for condition
*
* Please use DBA::selectFirst or DBA::exists whenever this is possible.
*
- * @brief Fetches the first row
* @param string $sql SQL statement
* @return array first row of query
* @throws \Exception
}
/**
- * @brief Returns the number of affected rows of the last statement
+ * Returns the number of affected rows of the last statement
*
* @return int Number of rows
*/
}
/**
- * @brief Returns the number of columns of a statement
+ * Returns the number of columns of a statement
*
* @param object Statement object
* @return int Number of columns
return DI::dba()->columnCount($stmt);
}
/**
- * @brief Returns the number of rows of a statement
+ * Returns the number of rows of a statement
*
* @param PDOStatement|mysqli_result|mysqli_stmt Statement object
* @return int Number of rows
}
/**
- * @brief Fetch a single row
+ * Fetch a single row
*
* @param mixed $stmt statement object
* @return array current row
}
/**
- * @brief Insert a row into a table
+ * Insert a row into a table
*
* @param string|array $table Table name or array [schema => table]
* @param array $param parameter array
}
/**
- * @brief Fetch the id of the last insert command
+ * Fetch the id of the last insert command
*
* @return integer Last inserted id
*/
}
/**
- * @brief Locks a table for exclusive write access
+ * Locks a table for exclusive write access
*
* This function can be extended in the future to accept a table array as well.
*
}
/**
- * @brief Unlocks all locked tables
+ * Unlocks all locked tables
*
* @return boolean was the unlock successful?
* @throws \Exception
}
/**
- * @brief Starts a transaction
+ * Starts a transaction
*
* @return boolean Was the command executed successfully?
*/
}
/**
- * @brief Does a commit
+ * Does a commit
*
* @return boolean Was the command executed successfully?
*/
}
/**
- * @brief Does a rollback
+ * Does a rollback
*
* @return boolean Was the command executed successfully?
*/
}
/**
- * @brief Delete a row from a table
+ * Delete a row from a table
*
* @param string|array $table Table name
* @param array $conditions Field condition(s)
}
/**
- * @brief Updates rows
+ * Updates rows in the database.
*
- * Updates rows in the database. When $old_fields is set to an array,
+ * When $old_fields is set to an array,
* the system will only do an update if the fields in that array changed.
*
* Attention:
/**
* Retrieve a single record from a table and returns it in an associative array
*
- * @brief Retrieve a single record from a table
* @param string|array $table Table name or array [schema => table]
* @param array $fields
* @param array $condition
}
/**
- * @brief Select rows from a table and fills an array with the data
+ * Select rows from a table and fills an array with the data
*
* @param string|array $table Table name or array [schema => table]
* @param array $fields Array of selected fields, empty for all
}
/**
- * @brief Select rows from a table
+ * Select rows from a table
*
* @param string|array $table Table name or array [schema => table]
* @param array $fields Array of selected fields, empty for all
}
/**
- * @brief Counts the rows from a table satisfying the provided condition
+ * Counts the rows from a table satisfying the provided condition
*
* @param string|array $table Table name or array [schema => table]
* @param array $condition array of fields for condition
}
/**
- * @brief Returns the SQL condition string built from the provided condition array
+ * Returns the SQL condition string built from the provided condition array
*
* This function operates with two modes.
* - Supplied with a filed/value associative array, it builds simple strict
}
/**
- * @brief Returns the SQL parameter string built from the provided parameter array
+ * Returns the SQL parameter string built from the provided parameter array
*
* @param array $params
* @return string
}
/**
- * @brief Fills an array with data from a query
+ * Fills an array with data from a query
*
* @param object $stmt statement object
* @param bool $do_close
}
/**
- * @brief Returns the error number of the last query
+ * Returns the error number of the last query
*
* @return string Error number (0 if no error)
*/
}
/**
- * @brief Returns the error message of the last query
+ * Returns the error message of the last query
*
* @return string Error message ('' if no error)
*/
}
/**
- * @brief Closes the current statement
+ * Closes the current statement
*
* @param object $stmt statement object
* @return boolean was the close successful?
}
/**
- * @brief Return a list of database processes
+ * Return a list of database processes
*
* @return array
* 'list' => List of processes, separated in their different states
}
/**
- * @brief Escapes a whole array
+ * Escapes a whole array
*
* @param mixed $arr Array with values to be escaped
* @param boolean $add_quotation add quotation marks for string values
projects / friendica.git / blobdiff