Pelzini

source of /viewer/database_mysql.php

The MySQL wrapper functions

<?php
/*
Copyright 2008 Josh Heidenreich
 
This file is part of Pelzini.
 
Pelzini is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
 
Pelzini is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with Pelzini.  If not, see <http://www.gnu.org/licenses/>.
*/
 
/**
 * The MySQL wrapper functions
 * @package Viewer
 * @author Josh Heidenreich
 * @since 0.2
 **/
 
 
/**
 * Connects to the MySQL database
 **/
function db_connect($settings)
{
    global $db_connection;
 
    if (!function_exists('mysql_connect')) {
        die('Unable to connect to database because "mysql" extension is not available');
    }
 
    $db_connection = @mysql_connect(
        $settings['server'],
        $settings['username'],
        $settings['password']
    );
 
    mysql_select_db($settings['name'], $db_connection);
}
 
 
/**
 * Makes a query to the MySQL database
 **/
function db_query($q)
{
    return mysql_query($q);
}
 
 
/**
 * Escapses a string for use by the MySQL database
 **/
function db_escape($str)
{
    return mysql_real_escape_string($str);
}
 
 
/**
 * Quotes a string as nessasary for use by hte MySQL database
 * The result will be different depending on the type of the input.
 *  - a number will be left as is
 *  - a string will be quoted
 *  - a null value will be returned as NULL
 **/
function db_quote($str)
{
    if ($str === null) {
        return 'NULL';
 
    } else if (is_int($str)) {
        return $str;
 
    } else {
        return "'" . mysql_real_escape_string($str) . "'";
    }
}
 
 
/**
 * Fetches a MySQL result set as an associative array
 **/
function db_fetch_assoc($res)
{
    return mysql_fetch_assoc($res);
}
 
 
/**
 * Returns the number of rows in a MySQL result set
 **/
function db_num_rows($res)
{
    return @mysql_num_rows($res);
}
 
 
/**
 * Returns the number of rows affected by the last MySQL query that was executed
 **/
function db_affected_rows($res)
{
    return mysql_affected_rows();
}
 
 
/**
 * Returns the last unique ID generated by a query
 **/
function db_insert_id()
{
    return mysql_insert_id();
}
 
 
?>