Class MySQL

---

Object
   |
   --Database
      |
      --MySQL

This is the database layer that will definately see the most use throughout the users of the script.
 It contains all of the major functions that php has for mysql databases, and should be more than
 adequate for our needs

• Package: pdbc
• Version: $Revision: 0.5 $ $Date: 2003/03/29 3:39 AM $
• Since: Japha 1.0 @
• Author: Ryan Gantt @

Class Variable Summary

Inherited Class Variable Summary

Method Summary

• void close()
  
• boolean connect()
  
• void fetch_object()
  
• void fetch_row()
  
• int num_rows()
  
• queryId query()
  
• boolean select_db()
  
• void __construct()
  
• void __destruct()
  

Inherited Method Summary

Inherited From Class Database

• getLinkId()
  
• release()
  
• setLinkId()
  
• __call()
  
• __destruct()
  
• __get()
  
• __set()
  

Inherited From Class Object

• clone()
  
• equals()
  
• equalsIgnoreCase()
  
• finalize()
  
• getClass()
  
• toString()
  
• wait()
  

Variable Detail

Method Detail

• void close()
  
  Usage: close ( )
  
  

  Unset, Unlink, Destroy, Delete (Gets rid of) a MySQL database connection

  Parameters

  • linkId 0 - the connection to close, defaults to the default connection @

  Info

  • Access: public
  
  
• boolean connect()
  
  Usage: connect ( $host, $user, $pass )
  
  

  Initiates the connection to a mysql database.

  Parameters

  • host $host - hostname for mysql connection. 'localhost' is fine in most cases @
  • user $user - username for mysql connection. @
  • pass $pass - password for mysql connection. @

  Info

  • Return: true iff the connection was successful @
  • Access: public
  • Exception: DatabaseException::CouldNotConnect if connection is unsuccessful @
  
  
• void fetch_object()
  
  Usage: fetch_object ( $query )
  
  

  Parameters

  Info

  
  
• void fetch_row()
  
  Usage: fetch_row ( $index, $type )
  
  

  Parameters

  Info

  
  
• int num_rows()
  
  Usage: num_rows ( $query )
  
  

  Count the number of result rows generated by a mysql query command

  Parameters

  • query $query - the command to execute that will generate rows (hopefully, if its a legal string) @

  Info

  • Return: the number of result rows @
  • Access: public
  • Exception: DatabaseException::GetNumRows if for some reason the query string is illegal or we can't access mysql_* functions for some reason @
  
  
• queryId query()
  
  Usage: query ( $query )
  
  

  Run a query command on the database

  Parameters

  • query $query - the command query to execute on the database @

  Info

  • Return: if the command was legally and successfully executed on the database @
  • Access: public
  • Exception: DatabaseException::BadQueryString if the query is unescaped or otherwise unacceptable for database use @
  
  
• boolean select_db()
  
  Usage: select_db ( $dbName )
  
  

  Selects a MySQL database to work with

  Parameters

  • dbName $dbName - the name of the database @

  Info

  • Return: true if the database was successfully selected @
  • Access: public
  • Exception: DatabaseException::SelectDatabase if the database was unsuccessful in being selected @
  
  
• void __construct()
  
  Usage: __construct ( $host, $user, $pass, [$connect = false] )
  
  

  Constructor does nothing but call an existing method to connect.

  Parameters

  • host $host - hostname of the database @
  • user $user - username for the database @
  • pass $pass - password for the database @

  Info

  • Access: public
  
  
• void __destruct()
  
  Usage: __destruct ( )
  
  

  Overrides: Database::__destruct()

  Deletes all the member variables that were used in this class

  Parameters

  Info

  • Access: public