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 A - Database Manager API

Constructor

/**
 * Database Manager Class Constructor
 *
 * Sets up the Database Manager Class
 *
 * @param array   $dsn          array containing the database connection details.
 * @param string  $adminuser    String containing the db adminuser name
 * @param string  $admipassword String containing the db adminuser password
 * @param boolean $persistent   Set true for persistent connection to database
 *
 * @access public
 */
public function __construct($dsn, $adminuser, $adminpasswd, $persistent = false)

setMode

/**
 * Database Manager setMode
 *
 * This function connects the dbManager to the correct function and database
 * driver.  The functions it can chose are "admin", "schema" or "dataaccess.
 * Any other options will throw an error
 *
 * @param string $function The function that is to be used.
 *
 * @return true If the selected function is enabled db error other wise
 */
public function setMode($function)

getAdminDriver

/**
 * Database Manager getAdminDriver
 *
 * This function returns the admin Driver pointer
 *
 * @return \g7mzr\db\interfaces\InterfaceDatabaseAdmin  Admin Driver
 */
public function getAdminDriver()

getSchemaDriver

/**
 * Database Manager getAdminDriver
 *
 * This function returns the schema Driver pointer
 *
 * @return \g7mzr\db\interfaces\InterfaceDatabaseSchema Schema Driver
 */
public function getSchemaDriver()

getDataDriver

/**
 * Database Manager getAdminDriver
 *
 * This function returns the schema Driver pointer
 *
 * @return \g7mzr\db\interfaces\InterfaceDatabaseDriver
 */
public function getDataDriver()

errorMessage

/**
 * Return a textual error message for a MDB2 error code
 *
 * @param int $value integer error code,
 *
 * @return string error message, or false if the error code was not recognised
 *
 * @access public
 */
public function errorMessage($value)