A PHP Database Composer Access Module.

Home Install Configure Database Manager Admin Schema Management Data Access Common Code Annex A - Database Manager API Annex B - Admin Manager API Annex C - Schema Manager API Annex D - Data Access API Annex E - Schema Driver API Annex F - Common API Download GitHub project Currently v0.5.0

© 2023. All rights reserved.

db-php A PHP Database Composer Access Module

Annex B - Admin Manager API

getDBVersion

/**
 * Function to get the database version
 *
 * This function gets the version of database currently being used.
 *
 * @return string database Version
 *
 * @access public
 */
public function getDBVersion();

userExists

/**
 * Function to check if a Database User Exist
 *
 * @param string $username The name of the database user.
 *
 * @return boolean true if user exists, False if, or DB Error.
 *
 * @access public
 */
public function userExists($username);

createUser

/**
 * Function to create the database user for the application
 *
 * @param string  $username   The name of the database user.
 * @param string  $password   The password for the database user.
 * @param boolean $unittestdb True if this is a test system.
 *
 * @return boolean true if user Created or exists. DB Error otherwise
 *
 * @access public
 */
public function createUser($username, $password, $unittestdb = false);

dropUser

/**
 * Function to drop the database user for the application
 *
 * @param string $username The name of the database user.
 *
 * @return boolean true if user dropped. DB Error otherwise
 *
 * @access public
 */
public function dropUser($username);

databaseExists

/**
 * Function to drop the database for the application
 *
 * @param string $database The name of the database.
 *
 * @return boolean true if database exists. DB Error otherwise
 *
 * @access public
 */
public function databaseExists($database);

createDatabase

/**
 * Function to create the database for the application
 *
 * @param string $database The name of the database.
 * @param string $username The name of the database user.
 *
 * @return boolean true if database Created or exists. DB Error otherwise
 *
 * @access public
 */
public function createDatabase($database, $username);

dropDatabase

/**
 * Function to drop the database for the application
 *
 * @param string $database The name of the database.
 *
 * @return boolean true if database deleted. DB Error otherwise
 *
 * @access public
 */
public function dropDatabase($database);