Location: PHPKode > scripts > XS PHP Library > xs-php-library/doc/db/DBError.html
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>
<!--NewPage-->
<HTML>
<HEAD>
	<!-- Generated by PhpDoc date: 'Mon, 11 Nov 2002 23:46:15 +0100' -->
	<TITLE>Docs For Class DBError</TITLE>
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>
</HEAD>
<BODY BGCOLOR='white'>

<!-- Start of Class Data -->
<H2>
	Class DBError
</H2>
<pre>
<pre><a href="../core/Object.html">Object</a>
   |
   --<a href="../core/Error.html">Error</a>
      |
      --DBError</pre>
</pre>
<H3>
	Classes extended from DBError:
</H3>

<p>
	<b><i>Located in File: Program_Root/dbmysql.inc.php</i></b><br>
</p>
<hr>
<!-- ========== Info from phpDoc block ========= -->
<b>DBError implements a class for reporting database error messages.</b>
<pre>

</pre>
<UL>
	
	<LI><b>Package</b> - <CODE>db</CODE></LI>
	
	<LI><b>Access</b> - <CODE>public</CODE></LI>
	
	<LI><b>Author</b> - <CODE>Robert Bala &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</CODE></LI>
	
</UL>

<hr>
<!-- =========== VAR SUMMARY =========== -->
<A NAME='var_summary'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
		<TD>
			<FONT SIZE='+2'><B>Class Variable Summary</B></FONT>
		</TD>
	</TR>

	
</TABLE>

<hr>
<!-- =========== VAR SUMMARY =========== -->
<A NAME='var_summary'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
		<TD>
			<FONT SIZE='+2'><B>Inherited Class Variable Summary</B></FONT>
		</TD>
	</TR>

	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<FONT SIZE='+2'><B>Inherited From Class <a href="../core/Error.html">Error</a></B></FONT>
			<blockquote>
			<table BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='95%'>
			<tr>
				<th>Variable</th>
				<th>Default Value</th>
				<th>Description</th>
			</tr>
				
				<tr>
				<td><CODE><B><A HREF='../core/Error.html#$_code'>$_code</A></B></CODE></td>
				<td><CODE>-><-</CODE></td>
				<td>Error code</td>
				</tr>
				
				<tr>
				<td><CODE><B><A HREF='../core/Error.html#$_message'>$_message</A></B></CODE></td>
				<td><CODE>-><-</CODE></td>
				<td>Error message</td>
				</tr>
				
			</table>
			</blockquote>
		</TD>
	</TR>
	
</TABLE>

<hr>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
		<TD>
			<FONT SIZE='+2'><B>Inherited Method Summary</B></FONT>
		</TD>
	</TR>

	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<FONT SIZE='+2'><B>Inherited From Class <a href="../core/Error.html">Error</a></B></FONT>
			<blockquote>
			<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='95%'>
				<tr>
					<th>Function</th>
					<th>Description</th>
				</tr>
				
				<tr>
					<td><CODE><B><A HREF='../core/Error.html#constructor Error'>constructor Error ( [$message = ''], [$code = ''0''], [$reply = ''null''] )</A></B></CODE></td>
					<td>Error class constructor.</td>
				
				<tr>
					<td><CODE><B><A HREF='../core/Error.html#getCode'>getCode (  )</A></B></CODE></td>
					<td>Get the error code from the error object.</td>
				
				<tr>
					<td><CODE><B><A HREF='../core/Error.html#getMessage'>getMessage (  )</A></B></CODE></td>
					<td>Get the error message from the error object.</td>
				
			</table>
			</blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<FONT SIZE='+2'><B>Inherited From Class <a href="../core/Object.html">Object</a></B></FONT>
			<blockquote>
			<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='95%'>
				<tr>
					<th>Function</th>
					<th>Description</th>
				</tr>
				
				<tr>
					<td><CODE><B><A HREF='../core/Object.html#constructor Object'>constructor Object (  )</A></B></CODE></td>
					<td>Object class constructor.</td>
				
				<tr>
					<td><CODE><B><A HREF='../core/Object.html#classMethods'>classMethods (  )</A></B></CODE></td>
					<td>Retrieves the class methods names of the object.</td>
				
				<tr>
					<td><CODE><B><A HREF='../core/Object.html#className'>className (  )</A></B></CODE></td>
					<td>Retrieves the name of the class of the object.</td>
				
				<tr>
					<td><CODE><B><A HREF='../core/Object.html#classParent'>classParent (  )</A></B></CODE></td>
					<td>Retrieves the parent class name for the object.</td>
				
				<tr>
					<td><CODE><B><A HREF='../core/Object.html#classProperties'>classProperties (  )</A></B></CODE></td>
					<td>Retrieves the class properties names of the object.</td>
				
				<tr>
					<td><CODE><B><A HREF='../core/Object.html#inheritsFrom'>inheritsFrom ( [$class = ] )</A></B></CODE></td>
					<td>Check if the objects inherits from the specified class.</td>
				
			</table>
			</blockquote>
		</TD>
	</TR>
	
</TABLE>

<br>
<!-- should have constructor at some point -->
<!-- =========== Method SUMMARY =========== -->
<A NAME='Method_summary'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
		<TD>
			<FONT SIZE='+2'><B>Method Summary</B></FONT>
		</TD>
	</TR>

	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='DBError.html#constructor DBError'>void constructor DBError ( [$message = ''], [$code = ''0''], [$reply = ''null''] )</A></B></CODE>
			<BR>
			<blockquote> Error class constructor. </blockquote>
		</TD>
	</TR>
	
</TABLE>

<hbr>
<!-- ============ VARIABLE DETAIL =========== -->

<A NAME='variable_detail'></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
		<TD>
			<FONT SIZE='+2'><B>Variable Detail</B></FONT>
		</TD>
	</TR>
</TABLE>



<hr>
<!-- ============ FUNCTION DETAIL =========== -->

<A NAME='function_detail'></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
		<TD>
			<FONT SIZE='+2'><B>Method Detail</B></FONT>
		</TD>
	</TR>
</TABLE>


<A NAME='constructor DBError'><!-- --></A><H3>constructor DBError</H3>
<P><B>void constructor DBError ( [$message = ''], [$code = ''0''], [$reply = ''null''] )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Error class constructor.</b>
<pre>
The $reply array should has action and option keys eg.
 $reply = array('action' =&gt; ERROR_ACTION_WRITE, 'option' =&gt; 'logfile.log');
 Action key can be set with one of the following constants:
 ERROR_ACTION_ABORT, ERROR_ACTION_PRINT,
 ERROR_ACTION_LOGIN, ERROR_ACTION_EMAIL,
 ERROR_ACTION_DEBUG, ERROR_ACTION_WRITE,
 ERROR_ACTION_RAISE.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $message</i>: error message, defaults to "Unexpected Error".</CODE></DD>
	
	<DD><CODE>- <i>int $code</i>: error code (optional), defaults to 0.</CODE></DD>
	
	<DD><CODE>- <i>array $reply</i>: error mode of operation.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>


<hr>
</HTML>
Return current item: XS PHP Library