Skip to content

fix: PSR, PHPDoc, Prepared Statements, More Timespan #312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TheWitness wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

fix: PSR, PHPDoc, Prepared Statements, More Timespan #312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f03e2b
fix: PSR, PHPDoc, Prepared Statements, More Timespan
TheWitness Apr 10, 2026
53b6476
fix: Syntax error
TheWitness Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
167 changes: 93 additions & 74 deletions database.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,22 @@

/**
* syslog_db_connect_real - makes a connection to the database server
* @param $host - the hostname of the database server, 'localhost' if the database server is running
* on this machine
*
* @param $user - the username to connect to the database server as
* @param $pass - the password to connect to the database server with
* @param $db_name - the name of the database to connect to
* @param $db_type - the type of database server to connect to, only 'mysql' is currently supported
* @param $retries - the number a time the server should attempt to connect before failing
* @param $db_ssl - true or false, is the database using ssl
* @param $db_ssl_key - the path to the ssl key file
* @param $db_ssl_cert - the path to the ssl cert file
* @param $db_ssl_ca - the path to the ssl ca file
*
* @return (object) connection_id for success, (bool) '0' for error
*
* @param string $host The hostname of the database server,
* 'localhost' if the database server is running
* on this machine
* @param string $user The username to connect to the database server as
* @param string $pass The password to connect to the database server with
* @param string $db_name The name of the database to connect to
* @param string $db_type The type of database server to connect to, only 'mysql' is currently supported
* @param int $port The database port. Defaults to 3306
* @param int $retries The number a time the server should attempt to connect before failing
* @param bool $db_ssl true or false, is the database using ssl
* @param string $db_ssl_key The path to the ssl key file
* @param string $db_ssl_cert The path to the ssl cert file
* @param string $db_ssl_ca The path to the ssl ca file
*
* @return object|bool connection_id for success, or bool false for error
*/
function syslog_db_connect_real($host, $user, $pass, $db_name, $db_type, $port = '3306', $retries = 20, $db_ssl = '',
$db_ssl_key = '', $db_ssl_cert = '', $db_ssl_ca = '') {
Expand All @@ -47,9 +49,9 @@ function syslog_db_connect_real($host, $user, $pass, $db_name, $db_type, $port =
/**
* syslog_db_close - closes the open connection
*
* @param $syslog_cnn - the connection object to connect to
* @param object $syslog_cnn The connection object to connect to
*
* @return the result of the close command
* @return bool the result of the close command
*/
function syslog_db_close($syslog_cnn) {
return db_close($syslog_cnn);
Expand All @@ -58,193 +60,210 @@ function syslog_db_close($syslog_cnn) {
/**
* syslog_db_execute - run an sql query and do not return any output
*
* @param $syslog_cnn - the connection object to connect to
* @param $sql - the sql query to execute
* @param $log - whether to log error messages, defaults to true
* @param string $sql The sql query to execute
* @param bool $log Whether to log error messages, defaults to true
*
* @return '1' for success, '0' for error
* @return int 1 for success, 0 for error
*/
function syslog_db_execute($sql, $log = TRUE) {
function syslog_db_execute($sql, $log = true) {
global $syslog_cnn;

return db_execute($sql, $log, $syslog_cnn);
}

/**
* syslog_db_execute_prepared - run an sql query and do not return any output
*
* @param $sql - the sql query to execute
* @param $log - whether to log error messages, defaults to true
* @param string $sql The sql query to execute
* @param array $parms The sql params for the prepare
* @param bool $log Whether to log error messages, defaults to true
*
* @return '1' for success, '0' for error
*/
function syslog_db_execute_prepared($sql, $parms = array(), $log = TRUE) {
function syslog_db_execute_prepared($sql, $parms = [], $log = true) {
global $syslog_cnn;

return db_execute_prepared($sql, $parms, $log, $syslog_cnn);
}

/**
* syslog_db_fetch_cell - run a 'select' sql query and return the first column of the
* first row found
* first row found
*
* @param $sql - the sql query to execute
* @param $log - whether to log error messages, defaults to true
* @param $col_name - use this column name instead of the first one
* @param string $sql The sql query to execute
* @param string $col_name Use this column name instead of the first one
* @param bool $log Whether to log error messages, defaults to true
*
* @return (bool) the output of the sql query as a single variable
* @return bool the output of the sql query as a single variable
*/
function syslog_db_fetch_cell($sql, $col_name = '', $log = TRUE) {
function syslog_db_fetch_cell($sql, $col_name = '', $log = true) {
global $syslog_cnn;

return db_fetch_cell($sql, $col_name, $log, $syslog_cnn);
}

/**
* syslog_db_fetch_cell_prepared - run a 'select' sql query and return the first column of the
* first row found
* first row found
*
* @param $sql - the sql query to execute
* @param $params - an array of parameters
* @param $col_name - use this column name instead of the first one
* @param $log - whether to log error messages, defaults to true
* @param string $sql The sql query to execute
* @param array $params An array of parameters
* @param string $col_name Use this column name instead of the first one
* @param bool $log Whether to log error messages, defaults to true
*
* @return (bool) the output of the sql query as a single variable
* @return bool The output of the sql query as a single variable
*/
function syslog_db_fetch_cell_prepared($sql, $params = array(), $col_name = '', $log = TRUE) {
function syslog_db_fetch_cell_prepared($sql, $params = [], $col_name = '', $log = true) {
global $syslog_cnn;

return db_fetch_cell_prepared($sql, $params, $col_name, $log, $syslog_cnn);
}
Comment on lines 89 to 120
Copy link

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PHPDoc return types for syslog_db_fetch_cell() / syslog_db_fetch_cell_prepared() are documented as bool, but these wrappers return the first-cell value (string/int/etc) or false. Update the @return types to reflect the actual mixed return value to avoid misleading callers and static analysis noise.

Copilot uses AI. Check for mistakes.

/**
* syslog_db_fetch_row - run a 'select' sql query and return the first row found
*
* @param $sql - the sql query to execute
* @param $log - whether to log error messages, defaults to true
* @param string $sql The sql query to execute
* @param bool $log Whether to log error messages, defaults to true
*
* @return the first row of the result as a hash
* @return array|bool The first row of the result as a hash
*/
function syslog_db_fetch_row($sql, $log = TRUE) {
function syslog_db_fetch_row($sql, $log = true) {
global $syslog_cnn;

return db_fetch_row($sql, $log, $syslog_cnn);
}

/**
* syslog_db_fetch_row_prepared - run a 'select' sql query and return the first row found
*
* @param $sql - the sql query to execute
* @param $params - an array of parameters
* @param $log - whether to log error messages, defaults to true
* @param string $sql The sql query to execute
* @param array $params An array of parameters
* @param bool $log Whether to log error messages, defaults to true
*
* @return the first row of the result as a hash
* @return array|bool The first row of the result as a hash
*/
function syslog_db_fetch_row_prepared($sql, $params = array(), $log = TRUE) {
function syslog_db_fetch_row_prepared($sql, $params = [], $log = true) {
global $syslog_cnn;

return db_fetch_row_prepared($sql, $params, $log, $syslog_cnn);
}

/**
* syslog_db_fetch_assoc - run a 'select' sql query and return all rows found
*
* @param $sql - the sql query to execute
* @param $log - whether to log error messages, defaults to true
* @param string $sql The sql query to execute
* @param bool $log Whether to log error messages, defaults to true
*
* @return the entire result set as a multi-dimensional hash
* @return array|bool The entire result set as a multi-dimensional hash
*/
function syslog_db_fetch_assoc($sql, $log = TRUE) {
function syslog_db_fetch_assoc($sql, $log = true) {
global $syslog_cnn;

return db_fetch_assoc($sql, $log, $syslog_cnn);
}

/**
* syslog_db_fetch_assoc_prepared - run a 'select' sql query and return all rows found
*
* @param $sql - the sql query to execute
* @param $params - an array of parameters
* @param $log - whether to log error messages, defaults to true
* @param string $sql The sql query to execute
* @param array $params An array of parameters
* @param bool $log Whether to log error messages, defaults to true
*
* @return the entire result set as a multi-dimensional hash
* @return array|bool The entire result set as a multi-dimensional hash
*/
function syslog_db_fetch_assoc_prepared($sql, $params = array(), $log = TRUE) {
function syslog_db_fetch_assoc_prepared($sql, $params = [], $log = true) {
global $syslog_cnn;

return db_fetch_assoc_prepared($sql, $params, $log, $syslog_cnn);
}

/**
* syslog_db_fetch_insert_id - get the last insert_id or auto incriment
*
* @param $syslog_cnn - the connection object to connect to
* @param object $syslog_cnn The connection object to connect to
*
* @return the id of the last auto incriment row that was created
* @return int The id of the last auto incriment row that was created
*/
function syslog_db_fetch_insert_id() {
global $syslog_cnn;
return db_fetch_insert_id($syslog_cnn);

return db_fetch_insert_id($syslog_cnn);
}

/**
* syslog_db_replace - replaces the data contained in a particular row
*
* @param $table_name - the name of the table to make the replacement in
* @param $array_items - an array containing each column -> value mapping in the row
* @param $keyCols - the name of the column containing the primary key
* @param $autoQuote - whether to use intelligent quoting or not
* @param string $table_name The name of the table to make the replacement in
* @param array $array_items An array containing each column -> value mapping in the row
* @param mixed $keyCols The name of the column containing the primary key
* @param bool $autoQuote Whether to use intelligent quoting or not
*
* @return the auto incriment id column (if applicable)
* @return bool The auto incriment id column (if applicable)
*/
function syslog_db_replace($table_name, $array_items, $keyCols) {
global $syslog_cnn;

return db_replace($table_name, $array_items, $keyCols, $syslog_cnn);
}

/**
* syslog_sql_save - saves data to an sql table
*
* @param $array_items - an array containing each column -> value mapping in the row
* @param $table_name - the name of the table to make the replacement in
* @param $key_cols - the primary key(s)
* @param array $array_items An array containing each column -> value mapping in the row
* @param string $table_name The name of the table to make the replacement in
* @param mixed $key_cols The primary key(s)
* @param bool $autoinc Is the primary key autoinc
*
* @return the auto incriment id column (if applicable)
* @return int The auto incriment id column (if applicable)
*/
function syslog_sql_save($array_items, $table_name, $key_cols = 'id', $autoinc = true) {
global $syslog_cnn;

return sql_save($array_items, $table_name, $key_cols, $autoinc, $syslog_cnn);
}

/**
* syslog_db_table_exists - checks whether a table exists
*
* @param $table - the name of the table
* @param $log - whether to log error messages, defaults to true
* @param string $table The name of the table
* @param bool $log Whether to log error messages, defaults to true
*
* @return (bool) the output of the sql query as a single variable
* @return bool The output of the sql query as a single variable
*/
function syslog_db_table_exists($table, $log = true) {
global $syslog_cnn;

preg_match("/([`]{0,1}(?<database>[\w_]+)[`]{0,1}\.){0,1}[`]{0,1}(?<table>[\w_]+)[`]{0,1}/", $table, $matches);

if ($matches !== false && array_key_exists('table', $matches)) {
$sql = 'SHOW TABLES LIKE \'' . $matches['table'] . '\'';

return (db_fetch_cell($sql, '', $log, $syslog_cnn) ? true : false);
}

return false;
}

function syslog_db_column_exists($table, $column, $log = true) {
global $syslog_cnn;

return db_column_exists($table, $column, $log, $syslog_cnn);
}

function syslog_db_add_column($table, $column, $log = true) {
global $syslog_cnn;

return db_add_column($table, $column, $log, $syslog_cnn);
}

/**
* syslog_db_affected_rows - return the number of rows affected by the last transaction
*
* @return (bool|int) The number of rows affected by the last transaction,
* or false on error
* @return bool|int The number of rows affected by the last transaction,
* or false on error
*/
function syslog_db_affected_rows() {
global $syslog_cnn;
return db_affected_rows($syslog_cnn);;
}

return db_affected_rows($syslog_cnn);
}
Loading
Loading