Class: XoopsDatabase

Source Location: /class/database/database.php

Class XoopsDatabase

Class Overview

Abstract base class for Database access classes

Located in /class/database/database.php [line 58]



		
				Author(s):
		
		
		
API Tags:
Abstract:  

Information Tags:
Copyright:  copyright (c) 2000-2003 XOOPS.org
Since:  XOOPS
License:  GNU General Public License (GPL)

Properties

Methods

[ Top ]
Descendants
Child Class Description
XoopsMySQLDatabase connection to a mysql database
XoopsMySQLiDatabase Database Object for a MySQL database.

[ Top ]
Property Summary
boolean   $allowWebChanges   If statements that modify the database are selected
object XoopsLogger   $logger   reference to a XoopsLogger object
string   $prefix   Prefix for tables in the database

[ Top ]
Method Summary
XoopsDatabase   XoopsDatabase()   constructor
string   prefix()   attach the prefix.'_' to a given tablename
void   setLogger()   assign a XoopsLogger object to the database
void   setPrefix()   set the prefix for tables in the database

[ Top ]
Properties
boolean   $allowWebChanges = false [line 76]

If statements that modify the database are selected


[ Top ]
object XoopsLogger   $logger [line 70]

reference to a XoopsLogger object

API Tags:
See:  XoopsLogger


[ Top ]
string   $prefix = '' [line 64]

Prefix for tables in the database


[ Top ]
Methods
Constructor XoopsDatabase  [line 83]

  XoopsDatabase XoopsDatabase( )

constructor

will always fail, because this is an abstract class!



[ Top ]
prefix  [line 117]

  string prefix( [string $tablename = '']  )

attach the prefix.'_' to a given tablename

if tablename is empty, only prefix will be returned

Parameters:
string   $tablename:  tablename

API Tags:
Return:  prefixed tablename, just prefix if tablename is empty


[ Top ]
setLogger  [line 94]

  void setLogger( &$logger, object $logger  )

assign a XoopsLogger object to the database

Parameters:
object   $logger:  reference to a XoopsLogger object
   &$logger: 

API Tags:
See:  XoopsLogger


[ Top ]
setPrefix  [line 104]

  void setPrefix( string $value  )

set the prefix for tables in the database

Parameters:
string   $value:  table prefix


[ Top ]

Documentation generated on Sat, 15 Nov 2008 14:12:26 -0600 by phpDocumentor 1.4.1