atari-legend / legacy

public/php/lib/Db.php

<?php
/* Database utility functions */
namespace AL\Db;

/**
 * Get an error context message
 *
 * @param  $context Human friendly context message

The type AL\Db\Human was not found. Maybe you did not declare it correctly or list all dependencies?

 * @return An error context string

The type AL\Db\An was not found. Maybe you did not declare it correctly or list all dependencies?

 */
function get_error_context($context) {
    return "(Context: $context)";

The expression return '(Context: '.$context.')' returns the type string which is incompatible with the documented return type AL\Db\An.

}

/**
 * Prepare a statement for the given query and parameters and handle errors
 *
 * @param  $context A human-friendly string giving the context the query is running

The type AL\Db\A was not found. Maybe you did not declare it correctly or list all dependencies?

 *  in. This will be output in error messages if something goes wrong
 * @param  $mysqli Database connection

The type AL\Db\Database was not found. Maybe you did not declare it correctly or list all dependencies?

 * @param  $query The SQL query to execute, using ? placeholders for parameters
 * @param  $bind_string The string representing the types of parameters to bind

The type AL\Db\The was not found. Maybe you did not declare it correctly or list all dependencies?

 *  (See mysqli_bind_param()), e.g. "ss" for 2 strings. Pass NULL if the query
 *  doesn't have parameters
 * @param  $params The list of parameters to bind. Pass NULL if the query doesn't
 *  have parameters
 * @return A prepared statement that has been executed
 */
function execute_query($context, $mysqli, $query, $bind_string, ...$params) {
    $err_ctx = get_error_context($context);

    $stmt = $mysqli->prepare($query)
        or die("Error preparing query [$query] $err_ctx: ".$mysqli->error);

Using exit here is not recommended.

    if ($bind_string !== null) {
        $stmt->bind_param($bind_string, ...$params)
            or die("Error binding parameters $err_ctx");

Using exit here is not recommended.

    } elseif (strstr($query, "?")) {
        die("Error: The query [$query] contained parameters (?) but didn't have a bind string $err_ctx");

Using exit here is not recommended.

    }

    $stmt->execute()
        or die("Error executing statement for [$query] $err_ctx: ".$mysqli->error);

Using exit here is not recommended.

    return $stmt;
}

/**
 * Bind variables to a prepared statement and handle errors
 *
 * @param $context A human-friendly string giving the context the query is running
 *  in. This will be output in error messages if something goes wrong
 * @param $stmt Prepared statement to bind results on

The type AL\Db\Prepared was not found. Maybe you did not declare it correctly or list all dependencies?

 * @param $params Variables to bind to the statement result

The type AL\Db\Variables was not found. Maybe you did not declare it correctly or list all dependencies?

 */
function bind_result($context, $stmt, &...$params) {
    $err_ctx = get_error_context($context);

    $stmt->bind_result(...$params)
        or die("Error binding results $err_ctx");

Using exit here is not recommended.

}

/**
 * Assemble multiple constraints into a SQL string with the proper
 * WHERE / AND syntax depending on the number of constraints
 * @param $constraints A list of constraints, like "id = ?" or
 *  "name LIKE ?".
 * @return String A SQL string with constraints suitable
 *  to use in a SQL query
 */
function assemble_constraints($constraints) {
    $query = "";
    if (count($constraints) > 1) {
        $query .= " WHERE ".array_shift($constraints);
        $query .= " AND ".join($constraints, " AND ");

' AND ' of type string is incompatible with the type array|null expected by parameter $array of join().

    } elseif (count($constraints) == 1) {
        $query .= " WHERE ".array_shift($constraints);
    }

    return $query;
}