Location: PHPKode > scripts > CLog Class > clog-class/doc.html
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class CLog</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class CLog</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
		<p class="notes">
			Located in <a class="field" href="_Clog_php.html">/Clog.php</a> (line <span class="field">60</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
								<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$m_fileName" title="details" class="var-name">$m_fileName</a>
				</div>
								<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$m_lastErrorString" title="details" class="var-name">$m_lastErrorString</a>
				</div>
								<div class="var-title">
					<span class="var-type">int</span>
					<a href="#$m_level" title="details" class="var-name">$m_level</a>
				</div>
								<div class="var-title">
					<span class="var-type">int</span>
					<a href="#$m_lineNumber" title="details" class="var-name">$m_lineNumber</a>
				</div>
							</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
								
				<div class="method-definition">
											<span class="method-result">CLog</span>
										<a href="#CLog" title="details" class="method-name">CLog</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#debug" title="details" class="method-name">debug</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errstr</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errfile</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errline</span> = <span class="var-default">NULL</span>])
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#error" title="details" class="method-name">error</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errstr</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errfile</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errline</span> = <span class="var-default">NULL</span>])
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#fatal" title="details" class="method-name">fatal</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errstr</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errfile</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errline</span> = <span class="var-default">NULL</span>])
									</div>
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_fileName" title="details" class="method-name">get_fileName</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_lastErrorString" title="details" class="method-name">get_lastErrorString</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#get_level" title="details" class="method-name">get_level</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_levelName" title="details" class="method-name">get_levelName</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#get_lineNumber" title="details" class="method-name">get_lineNumber</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#log" title="details" class="method-name">log</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errstr</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#notice" title="details" class="method-name">notice</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errstr</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errfile</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errline</span> = <span class="var-default">NULL</span>])
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_fileName" title="details" class="method-name">set_fileName</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$in_fileName</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_lastErrorString" title="details" class="method-name">set_lastErrorString</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$in_lastErrorString</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_level" title="details" class="method-name">set_level</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$in_level</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_lineNumber" title="details" class="method-name">set_lineNumber</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$in_lineNumber</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#warning" title="details" class="method-name">warning</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errstr</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errfile</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errline</span> = <span class="var-default">NULL</span>])
									</div>
							</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$m_fileName" id="$m_fileName"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$m_fileName</span>
			 = <span class="var-default"> &quot;&quot; </span>			(line <span class="line-number">71</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Stores file Name of current error</p>
	
	
		
		

</div>
<a name="var$m_lastErrorString" id="$m_lastErrorString"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$m_lastErrorString</span>
			 = <span class="var-default"> &quot;&quot;</span>			(line <span class="line-number">81</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Stores last Error description</p>
	
	
		
		

</div>
<a name="var$m_level" id="$m_level"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$m_level</span>
			 = <span class="var-default">  CLOG_DEBUG</span>			(line <span class="line-number">66</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Stores level of current error</p>
	
	
		
		

</div>
<a name="var$m_lineNumber" id="$m_lineNumber"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$m_lineNumber</span>
			 = <span class="var-default"> &quot;0&quot; </span>			(line <span class="line-number">76</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Stores line Number of current error</p>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodCLog" id="CLog"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor CLog</span> (line <span class="line-number">86</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">**************************************************************************************</p>
<p class="description"><p>CONSTRUCTOR ***************************************************************************************</p></p>
	
	<div class="method-signature">
		<span class="method-result">CLog</span>
		<span class="method-name">
			CLog
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methoddebug" id="debug"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">debug</span> (line <span class="line-number">114</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Static function to add a debug log</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			debug
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errstr</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errfile</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errline</span> = <span class="var-default">NULL</span>])
			</div>
	
		
		
	</div>
<a name="methoderror" id="error"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">error</span> (line <span class="line-number">142</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Static function to add a error log</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			error
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errstr</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errfile</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errline</span> = <span class="var-default">NULL</span>])
			</div>
	
		
		
	</div>
<a name="methodfatal" id="fatal"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">fatal</span> (line <span class="line-number">156</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Static function to add a fatal error and stops the program/script</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			fatal
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errstr</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errfile</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errline</span> = <span class="var-default">NULL</span>])
			</div>
	
		
		
	</div>
<a name="methodget_fileName" id="get_fileName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">get_fileName</span> (line <span class="line-number">379</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the varable m_fileName</p>
	<ul class="tags">
				<li><span class="field">return:</span> m_fileName</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_fileName
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodget_lastErrorString" id="get_lastErrorString"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_lastErrorString</span> (line <span class="line-number">345</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the varable m_lastErrorString</p>
	<ul class="tags">
				<li><span class="field">return:</span> m_lastErrorString</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_lastErrorString
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodget_level" id="get_level"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">get_level</span> (line <span class="line-number">396</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the varable m_level</p>
	<ul class="tags">
				<li><span class="field">return:</span> m_level</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			get_level
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodget_levelName" id="get_levelName"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_levelName</span> (line <span class="line-number">320</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">get the level name</p>
	<ul class="tags">
				<li><span class="field">author:</span> Rolf Wessels rolfdw[at]gmail.com</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_levelName
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodget_lineNumber" id="get_lineNumber"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">get_lineNumber</span> (line <span class="line-number">362</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the varable m_lineNumber</p>
	<ul class="tags">
				<li><span class="field">return:</span> m_lineNumber</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			get_lineNumber
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodlog" id="log"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">log</span> (line <span class="line-number">174</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Main loggin function</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			log
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errstr</span>)
			</div>
	
		
		
	</div>
<a name="methodnotice" id="notice"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">notice</span> (line <span class="line-number">100</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Static function to add a notice log</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			notice
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errstr</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errfile</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errline</span> = <span class="var-default">NULL</span>])
			</div>
	
		
		
	</div>
<a name="methodset_fileName" id="set_fileName"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">set_fileName</span> (line <span class="line-number">388</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set variable m_fileName</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_fileName
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$in_fileName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$in_fileName</span><span class="var-description">: in_fileName</span>			</li>
				</ul>
		
		
	</div>
<a name="methodset_lastErrorString" id="set_lastErrorString"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">set_lastErrorString</span> (line <span class="line-number">354</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set variable m_lastErrorString</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_lastErrorString
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$in_lastErrorString</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$in_lastErrorString</span><span class="var-description">: in_lastErrorString</span>			</li>
				</ul>
		
		
	</div>
<a name="methodset_level" id="set_level"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">set_level</span> (line <span class="line-number">405</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set variable m_level</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_level
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$in_level</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$in_level</span><span class="var-description">: in_level</span>			</li>
				</ul>
		
		
	</div>
<a name="methodset_lineNumber" id="set_lineNumber"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">set_lineNumber</span> (line <span class="line-number">371</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set variable m_lineNumber</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_lineNumber
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$in_lineNumber</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$in_lineNumber</span><span class="var-description">: in_lineNumber</span>			</li>
				</ul>
		
		
	</div>
<a name="methodwarning" id="warning"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">warning</span> (line <span class="line-number">129</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Static function to add a warning log</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			warning
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errstr</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errfile</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_errline</span> = <span class="var-default">NULL</span>])
			</div>
	
		
		
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 30 Jun 2006 03:08:59 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>
Return current item: CLog Class