Location: PHPKode > scripts > BookmarkParser > bookmarkparser/phpdoc/BookmarkParser.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 BookmarkParser</title>
			<link rel="stylesheet" href="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 BookmarkParser</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="short-description">This class parses IE, Netscape and Opera bookmark files and returns arrays with the bookmark / folder information.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">version:</span> 0.61 - 2003/07/07</li>
				<li><span class="field">copyright:</span> Lennart Groetzbach &lt;hide@address.com&gt; - distributed under the LGPL</li>
				<li><span class="field">author:</span> Lennart Groetzbach &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_BookmarkParser2_php.html">Program_Root/BookmarkParser2.php</a> (line <span class="field">66</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">mixed</span>
					<a href="#$error_message" title="details" class="var-name">$error_message</a>
				</div>
								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$foldersParsed" title="details" class="var-name">$foldersParsed</a>
				</div>
								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$urlsParsed" title="details" class="var-name">$urlsParsed</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">int</span>
										<a href="#parseInternetExplorer" title="details" class="method-name">parseInternetExplorer</a>
											(<span class="var-type">String</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$folderID</span>, <span class="var-type">String</span>&nbsp;<span class="var-name">$urlFunction</span>, <span class="var-type">String</span>&nbsp;<span class="var-name">$folderFunction</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$firstCall</span> = <span class="var-default">true</span>])
									</div>
								
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#parseNetscape" title="details" class="method-name">parseNetscape</a>
											(<span class="var-type">String</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$folderID</span>, <span class="var-type">String</span>&nbsp;<span class="var-name">$urlFunction</span>, <span class="var-type">String</span>&nbsp;<span class="var-name">$folderFunction</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#parseOpera" title="details" class="method-name">parseOpera</a>
											(<span class="var-type">String</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$folderID</span>, <span class="var-type">String</span>&nbsp;<span class="var-name">$urlFunction</span>, <span class="var-type">String</span>&nbsp;<span class="var-name">$folderFunction</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">Integer</span>
										<a href="#_callFunction" title="details" class="method-name">_callFunction</a>
											(<span class="var-type">String</span>&nbsp;<span class="var-name">$functionName</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$abortAmbiguous</span> = <span class="var-default">false</span>], <span class="var-type">mixed</span>&nbsp;<span class="var-name">2</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$error_message" id="$error_message"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$error_message</span>
						(line <span class="line-number">74</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The generated error messages, line feed seperated</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

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

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$foldersParsed</span>
						(line <span class="line-number">82</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The number of folders parsed after a function call</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

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

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$urlsParsed</span>
						(line <span class="line-number">90</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The number of bookmarks parsed after a function call</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</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="methodparseInternetExplorer" id="parseInternetExplorer"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">parseInternetExplorer</span> (line <span class="line-number">310</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses an IE bookmarks folder.</p>
<p class="description"><p>Parses the IE folder and files.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> -1 if error occurs</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			parseInternetExplorer
		</span>
					(<span class="var-type">String</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$folderID</span>, <span class="var-type">String</span>&nbsp;<span class="var-name">$urlFunction</span>, <span class="var-type">String</span>&nbsp;<span class="var-name">$folderFunction</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$firstCall</span> = <span class="var-default">true</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">String</span>
				<span class="var-name">$url</span><span class="var-description">: url to the bookmark file</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$folderID</span><span class="var-description">: id of the root folder</span>			</li>
					<li>
				<span class="var-type">String</span>
				<span class="var-name">$urlFunction</span><span class="var-description">: the function name to be called when an url is parsed</span>			</li>
					<li>
				<span class="var-type">String</span>
				<span class="var-name">$folderFunction</span><span class="var-description">: the function name to be called when a bookmark is parsed</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$firstCall</span><span class="var-description">: <p>only true, upon the first call</p><p></p></span>			</li>
				</ul>
		
		
	</div>
<a name="methodparseNetscape" id="parseNetscape"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">parseNetscape</span> (line <span class="line-number">222</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses a Netscape bookmark file</p>
<p class="description"><p>Parses the file, default name is &quot;bookmarks.html&quot;. Tested with Netscape 4.x and 6.x.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> -1 if error occurs</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			parseNetscape
		</span>
					(<span class="var-type">String</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$folderID</span>, <span class="var-type">String</span>&nbsp;<span class="var-name">$urlFunction</span>, <span class="var-type">String</span>&nbsp;<span class="var-name">$folderFunction</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">String</span>
				<span class="var-name">$url</span><span class="var-description">: url to the bookmark file</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$folderID</span><span class="var-description">: id of the root folder</span>			</li>
					<li>
				<span class="var-type">String</span>
				<span class="var-name">$urlFunction</span><span class="var-description">: the function name to be called when an url is parsed</span>			</li>
					<li>
				<span class="var-type">String</span>
				<span class="var-name">$folderFunction</span><span class="var-description">: <p>the function name to be called when a bookmark is parsed</p><p></p></span>			</li>
				</ul>
		
		
	</div>
<a name="methodparseOpera" id="parseOpera"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">parseOpera</span> (line <span class="line-number">109</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses an Opera bookmark file</p>
<p class="description"><p>Parses the file, default name for bookmark file is &quot;Opera6.adr&quot; Tested with Opera 6.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> -1 if error occurs</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			parseOpera
		</span>
					(<span class="var-type">String</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$folderID</span>, <span class="var-type">String</span>&nbsp;<span class="var-name">$urlFunction</span>, <span class="var-type">String</span>&nbsp;<span class="var-name">$folderFunction</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">String</span>
				<span class="var-name">$url</span><span class="var-description">: url to the bookmark file</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$folderID</span><span class="var-description">: id of the root folder</span>			</li>
					<li>
				<span class="var-type">String</span>
				<span class="var-name">$urlFunction</span><span class="var-description">: the function name to be called when an url is parsed</span>			</li>
					<li>
				<span class="var-type">String</span>
				<span class="var-name">$folderFunction</span><span class="var-description">: <p>the function name to be called when a bookmark is parsed</p><p></p></span>			</li>
				</ul>
		
		
	</div>
<a name="method_callFunction" id="_callFunction"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">_callFunction</span> (line <span class="line-number">382</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks</p>
	<ul class="tags">
				<li><span class="field">return:</span> -1 when an error occurs or the retrun value of the function</li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Integer</span>
		<span class="method-name">
			_callFunction
		</span>
					(<span class="var-type">String</span>&nbsp;<span class="var-name">$functionName</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$abortAmbiguous</span> = <span class="var-default">false</span>], <span class="var-type">mixed</span>&nbsp;<span class="var-name">2</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">String</span>
				<span class="var-name">$functionName</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$abortAmbiguous</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">2</span><span class="var-description">: <p>the params for the function</p><p></p></span>			</li>
				</ul>
		
		
	</div>
						
		</div>
	</div>
	
	<p class="notes" id="credit">
		Documention generated on Mon,  7 Jul 2003 22:57:20 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.1</a>
	</p>
	</div></body>
</html>
Return current item: BookmarkParser