*
* @return string
*/
- public static function serverInfo()
+ public static function serverInfo(): string
{
return DI::dba()->serverInfo();
}
* @return string
* @throws \Exception
*/
- public static function databaseName()
+ public static function databaseName(): string
{
return DI::dba()->databaseName();
}
* @param string $str
* @return string escaped string
*/
- public static function escape($str)
+ public static function escape(string $str): string
{
return DI::dba()->escape($str);
}
*
* @return boolean is the database connected?
*/
- public static function connected()
+ public static function connected(): bool
{
return DI::dba()->connected();
}
* @param string $sql An SQL string without the values
* @return string The input SQL string modified if necessary.
*/
- public static function anyValueFallback($sql)
+ public static function anyValueFallback(string $sql): string
{
return DI::dba()->anyValueFallback($sql);
}
* @param string $sql An SQL string without the values
* @return string The input SQL string modified if necessary.
*/
- public static function cleanQuery($sql)
+ public static function cleanQuery(string $sql): string
{
$search = ["\t", "\n", "\r", " "];
$replace = [' ', ' ', ' ', ' '];
* @param array $args Parameter array
* @return array universalized parameter array
*/
- public static function getParam($args)
+ public static function getParam(array $args): array
{
unset($args[0]);
* @return bool|object statement object or result object
* @throws \Exception
*/
- public static function p($sql)
+ public static function p(string $sql)
{
$params = self::getParam(func_get_args());
* @return boolean Was the query successfull? False is returned only if an error occurred
* @throws \Exception
*/
- public static function e($sql) {
-
+ public static function e(string $sql): bool
+ {
$params = self::getParam(func_get_args());
return DI::dba()->e($sql, $params);
*
* @param string|array $table Table name or array [schema => table]
* @param array $condition array of fields for condition
- *
* @return boolean Are there rows for that condition?
* @throws \Exception
*/
- public static function exists($table, $condition)
+ public static function exists(string $table, array $condition): bool
{
return DI::dba()->exists($table, $condition);
}
* @return array first row of query
* @throws \Exception
*/
- public static function fetchFirst($sql)
+ public static function fetchFirst(string $sql)
{
$params = self::getParam(func_get_args());
*
* @return int Number of rows
*/
- public static function affectedRows()
+ public static function affectedRows(): int
{
return DI::dba()->affectedRows();
}
* @param object Statement object
* @return int Number of columns
*/
- public static function columnCount($stmt)
+ public static function columnCount($stmt): int
{
return DI::dba()->columnCount($stmt);
}
* @param PDOStatement|mysqli_result|mysqli_stmt Statement object
* @return int Number of rows
*/
- public static function numRows($stmt)
+ public static function numRows($stmt): int
{
return DI::dba()->numRows($stmt);
}
* @return boolean was the insert successful?
* @throws \Exception
*/
- public static function insert($table, array $param, int $duplicate_mode = Database::INSERT_DEFAULT)
+ public static function insert($table, array $param, int $duplicate_mode = Database::INSERT_DEFAULT): bool
{
return DI::dba()->insert($table, $param, $duplicate_mode);
}
* @return boolean was the insert successful?
* @throws \Exception
*/
- public static function replace($table, $param)
+ public static function replace($table, array $param): bool
{
return DI::dba()->replace($table, $param);
}
*
* @return integer Last inserted id
*/
- public static function lastInsertId()
+ public static function lastInsertId(): int
{
return DI::dba()->lastInsertId();
}
* @return boolean was the lock successful?
* @throws \Exception
*/
- public static function lock($table)
+ public static function lock($table): bool
{
return DI::dba()->lock($table);
}
* @return boolean was the unlock successful?
* @throws \Exception
*/
- public static function unlock()
+ public static function unlock(): bool
{
return DI::dba()->unlock();
}
*
* @return boolean Was the command executed successfully?
*/
- public static function transaction()
+ public static function transaction(): bool
{
return DI::dba()->transaction();
}
*
* @return boolean Was the command executed successfully?
*/
- public static function commit()
+ public static function commit(): bool
{
return DI::dba()->commit();
}
*
* @return boolean Was the command executed successfully?
*/
- public static function rollback()
+ public static function rollback(): bool
{
return DI::dba()->rollback();
}
* @return boolean was the delete successful?
* @throws \Exception
*/
- public static function delete($table, array $conditions, array $options = [])
+ public static function delete($table, array $conditions, array $options = []): bool
{
return DI::dba()->delete($table, $conditions, $options);
}
* @return boolean was the update successfull?
* @throws \Exception
*/
- public static function update($table, array $fields, array $condition, $old_fields = [], array $params = [])
+ public static function update($table, array $fields, array $condition, $old_fields = [], array $params = []): bool
{
return DI::dba()->update($table, $fields, $condition, $old_fields, $params);
}
* @param string|array $tables
* @return string
*/
- public static function buildTableString($tables)
+ public static function buildTableString($tables): string
{
if (is_string($tables)) {
$tables = [$tables];
* @param $identifier
* @return string
*/
- public static function quoteIdentifier($identifier)
+ public static function quoteIdentifier(string $identifier): string
{
return '`' . str_replace('`', '``', $identifier) . '`';
}
* @param array $condition
* @return string
*/
- public static function buildCondition(array &$condition = [])
+ public static function buildCondition(array &$condition = []): string
{
$condition = self::collapseCondition($condition);
* @param array $condition
* @return array
*/
- public static function collapseCondition(array $condition)
+ public static function collapseCondition(array $condition): array
{
// Ensures an always true condition is returned
if (count($condition) < 1) {
* @return array A collapsed condition
* @see DBA::collapseCondition() for the condition array formats
*/
- public static function mergeConditions(array ...$conditions)
+ public static function mergeConditions(array ...$conditions): array
{
if (count($conditions) == 1) {
return current($conditions);
* @param array $params
* @return string
*/
- public static function buildParameter(array $params = [])
+ public static function buildParameter(array $params = []): string
{
$groupby_string = '';
if (!empty($params['group_by'])) {
*
* @return array Data array
*/
- public static function toArray($stmt, $do_close = true, int $count = 0): array
+ public static function toArray($stmt, bool $do_close = true, int $count = 0): array
{
return DI::dba()->toArray($stmt, $do_close, $count);
}
* Checks if $array is a filled array with at least one entry.
*
* @param mixed $array A filled array with at least one entry
- *
* @return boolean Whether $array is a filled array or an object with rows
*/
- public static function isResult($array)
+ public static function isResult($array): bool
{
return DI::dba()->isResult($array);
}
* @param boolean $add_quotation add quotation marks for string values
* @return void
*/
- public static function escapeArray(&$arr, $add_quotation = false)
+ public static function escapeArray(&$arr, bool $add_quotation = false)
{
DI::dba()->escapeArray($arr, $add_quotation);
}
}
}
- public function connect()
+ /**
+ * Tries to connect to database
+ *
+ * @return bool Success
+ */
+ public function connect(): bool
{
if (!is_null($this->connection) && $this->connected()) {
return $this->connected;
*
* @return string with either "pdo" or "mysqli"
*/
- public function getDriver()
+ public function getDriver(): string
{
return $this->driver;
}
* This function discriminate between the deprecated mysql API and the current
* object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
*
- * @return string
+ * @return string Database server information
*/
- public function serverInfo()
+ public function serverInfo(): string
{
if ($this->server_info == '') {
switch ($this->driver) {
/**
* Returns the selected database name
*
- * @return string
+ * @return string Database name
* @throws \Exception
*/
- public function databaseName()
+ public function databaseName(): string
{
$ret = $this->p("SELECT DATABASE() AS `db`");
$data = $this->toArray($ret);
* Analyze a database query and log this if some conditions are met.
*
* @param string $query The database query that will be analyzed
- *
+ * @return void
* @throws \Exception
*/
- private function logIndex($query)
+ private function logIndex(string $query)
{
if (!$this->configCache->get('system', 'db_log_index')) {
* Removes every not allowlisted character from the identifier string
*
* @param string $identifier
- *
* @return string sanitized identifier
* @throws \Exception
*/
- private function sanitizeIdentifier($identifier)
+ private function sanitizeIdentifier(string $identifier): string
{
return preg_replace('/[^A-Za-z0-9_\-]+/', '', $identifier);
}
}
}
- public function isConnected()
+ /**
+ * Returns connected flag
+ *
+ * @return bool Whether connection to database was success
+ */
+ public function isConnected(): bool
{
return $this->connected;
}
+ /**
+ * Checks connection status
+ *
+ * @return bool Whether connection to database was success
+ */
public function connected()
{
$connected = false;
*
* @return string The input SQL string modified if necessary.
*/
- public function anyValueFallback($sql)
+ public function anyValueFallback(string $sql): string
{
$server_info = $this->serverInfo();
if (version_compare($server_info, '5.7.5', '<') ||
*
* @return string The replaced SQL query
*/
- private function replaceParameters($sql, $args)
+ private function replaceParameters(string $sql, array $args): string
{
$offset = 0;
foreach ($args as $param => $value) {
* @return bool|object statement object or result object
* @throws \Exception
*/
- public function p($sql)
+ public function p(string $sql)
{
$this->profiler->startRecording('database');
* @return boolean Was the query successfull? False is returned only if an error occurred
* @throws \Exception
*/
- public function e($sql)
+ public function e(string $sql): bool
{
+ $retval = false;
$this->profiler->startRecording('database_write');
* @return boolean Are there rows for that condition?
* @throws \Exception
*/
- public function exists($table, $condition)
+ public function exists($table, array $condition): bool
{
if (empty($table)) {
return false;
*
* @param string $sql SQL statement
*
- * @return array first row of query
+ * @return array|bool first row of query or false on failure
* @throws \Exception
*/
- public function fetchFirst($sql)
+ public function fetchFirst(string $sql)
{
$params = DBA::getParam(func_get_args());
*
* @return int Number of rows
*/
- public function affectedRows()
+ public function affectedRows(): int
{
return $this->affected_rows;
}
*
* @return int Number of columns
*/
- public function columnCount($stmt)
+ public function columnCount($stmt): int
{
if (!is_object($stmt)) {
return 0;
*
* @return int Number of rows
*/
- public function numRows($stmt)
+ public function numRows($stmt): int
{
if (!is_object($stmt)) {
return 0;
*
* @param bool|PDOStatement|mysqli_stmt $stmt statement object
*
- * @return array|false current row
+ * @return array|bool Current row or false on failure
*/
public function fetch($stmt)
{
* @return boolean was the insert successful?
* @throws \Exception
*/
- public function insert($table, array $param, int $duplicate_mode = self::INSERT_DEFAULT)
+ public function insert($table, array $param, int $duplicate_mode = self::INSERT_DEFAULT): bool
{
if (empty($table) || empty($param)) {
$this->logger->info('Table and fields have to be set');
* @return boolean was the insert successful?
* @throws \Exception
*/
- public function replace($table, array $param)
+ public function replace($table, array $param): bool
{
if (empty($table) || empty($param)) {
$this->logger->info('Table and fields have to be set');
*
* @return integer Last inserted id
*/
- public function lastInsertId()
+ public function lastInsertId(): int
{
switch ($this->driver) {
case self::PDO:
* @return boolean was the lock successful?
* @throws \Exception
*/
- public function lock($table)
+ public function lock($table): bool
{
// See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
if ($this->driver == self::PDO) {
* @return boolean was the unlock successful?
* @throws \Exception
*/
- public function unlock()
+ public function unlock(): bool
{
// See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
$this->performCommit();
return true;
}
- protected function performCommit()
+ /**
+ * Performs the commit
+ *
+ * @return boolean Was the command executed successfully?
+ */
+ protected function performCommit(): bool
{
switch ($this->driver) {
case self::PDO:
*
* @return boolean Was the command executed successfully?
*/
- public function commit()
+ public function commit(): bool
{
if (!$this->performCommit()) {
return false;
*
* @return boolean Was the command executed successfully?
*/
- public function rollback()
+ public function rollback(): bool
{
$ret = false;
$ret = $this->connection->rollback();
break;
}
+
$this->in_transaction = false;
return $ret;
}
* @return boolean was the delete successful?
* @throws \Exception
*/
- public function delete($table, array $conditions)
+ public function delete($table, array $conditions): bool
{
if (empty($table) || empty($conditions)) {
$this->logger->info('Table and conditions have to be set');
*
* @return boolean was the update successfull?
* @throws \Exception
+ * @todo Implement "bool $update_on_duplicate" to avoid mixed type for $old_fields
*/
- public function update($table, $fields, $condition, $old_fields = [], $params = [])
+ public function update($table, array $fields, array $condition, $old_fields = [], array $params = [])
{
if (empty($table) || empty($fields) || empty($condition)) {
$this->logger->info('Table, fields and condition have to be set');
* @throws \Exception
* @see $this->select
*/
- public function selectFirst($table, array $fields = [], array $condition = [], $params = [])
+ public function selectFirst($table, array $fields = [], array $condition = [], array $params = [])
{
$params['limit'] = 1;
$result = $this->select($table, $fields, $condition, $params);
*
* @param array $fields
* @param array $options
- * @return array
+ * @return array Escaped fields
*/
- private function escapeFields(array $fields, array $options)
+ private function escapeFields(array $fields, array $options): array
{
// In the case of a "GROUP BY" we have to add all the ORDER fields to the fieldlist.
// This needs to done to apply the "ANY_VALUE(...)" treatment from below to them.
*/
public function count($table, array $condition = [], array $params = [])
{
+ // @TODO Can we dump this to have ": int" as returned type-hint?
if (empty($table)) {
return false;
}
* @param array $fields
* @return array casted fields
*/
- public function castFields(string $table, array $fields) {
+ public function castFields(string $table, array $fields): array
+ {
// When there is no data, we don't need to do something
if (empty($fields)) {
return $fields;
*
* @return string Error message ('' if no error)
*/
- public function errorMessage()
+ public function errorMessage(): string
{
return $this->error;
}
* @param string $name
* @return string content
*/
- public function getVariable(string $name)
+ public function getVariable(string $name): string
{
$result = $this->fetchFirst("SHOW GLOBAL VARIABLES WHERE `Variable_name` = ?", $name);
return $result['Value'] ?? null;
*
* @return boolean Whether $array is a filled array or an object with rows
*/
- public function isResult($array)
+ public function isResult($array): bool
{
// It could be a return value from an update statement
if (is_bool($array)) {
* @param mixed $value Array value
* @param string $key Array key
* @param boolean $add_quotation add quotation marks for string values
- *
* @return void
*/
- private function escapeArrayCallback(&$value, $key, $add_quotation)
+ private function escapeArrayCallback(&$value, string $key, bool $add_quotation)
{
if (!$add_quotation) {
if (is_bool($value)) {
*
* @param mixed $arr Array with values to be escaped
* @param boolean $add_quotation add quotation marks for string values
- *
* @return void
*/
- public function escapeArray(&$arr, $add_quotation = false)
+ public function escapeArray(&$arr, bool $add_quotation = false)
{
array_walk($arr, [$this, 'escapeArrayCallback'], $add_quotation);
}
/**
* Replaces a string in the provided fields of the provided table
*
- * @param string $table_name
+ * @param string $table_name Table name
* @param array $fields List of field names in the provided table
* @param string $search
* @param string $replace
+ * @return void
* @throws \Exception
*/
public function replaceInTableFields(string $table_name, array $fields, string $search, string $replace)
projects / friendica.git / commitdiff