Location: PHPKode > projects > Program E > docs/developer/application/_cms_include_retrieve_inc_php.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 page retrieve.inc.php</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
						<script src="../media/lib/classTree.js"></script>
												<script language="javascript" type="text/javascript">
				var imgPlus = new Image();
				var imgMinus = new Image();
				imgPlus.src = "../media/images/plus.png";
				imgMinus.src = "../media/images/minus.png";
				
				function showNode(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
							var oImg = document.layers["img" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
							var oImg = document.all["img" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
							var oImg = document.getElementById("img" + Node);
									break;
							}
					oImg.src = imgMinus.src;
					oTable.style.display = "block";
				}
				
				function hideNode(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
							var oImg = document.layers["img" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
							var oImg = document.all["img" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
							var oImg = document.getElementById("img" + Node);
									break;
							}
					oImg.src = imgPlus.src;
					oTable.style.display = "none";
				}
				
				function nodeIsVisible(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
									break;
							}
					return (oTable && oTable.style.display == "block");
				}
				
				function toggleNodeVisibility(Node){
					if (nodeIsVisible(Node)){
						hideNode(Node);
					}else{
						showNode(Node);
					}
				}
			</script>
					</head>
		<body>
			<div class="page-body">			

<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/cms/include/retrieve.inc.php</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-functions">Functions</a>
			</div>
	<div class="info-box-body">	
		<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">filesource:</span> <a href="..//__filesource/fsource_application__cmsincluderetrieve.inc.php.html">Source Code for this file</a></li>
			</ul>
		
			</div>
</div>
		

	
	
	
	<a name="sec-functions"></a>	
	<div class="info-box">
		<div class="info-box-title">Functions</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<span class="disabled">Functions</span>
		</div>
		<div class="info-box-body">	
			<a name="functionfindCategoryPattern" id="functionfindCategoryPattern"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">findCategoryPattern</span> (line <span class="line-number"><a href="..//__filesource/fsource_application__cmsincluderetrieve.inc.php.html#a43">43</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Given a specific template ID retrieve the corresponding PATTERN,  THAT and TOPIC.</p>
<p class="description"><p>Retrieve the Pattern, That and Topic using only the ID of the corresponding template.  This function has also been adapted to make it possible to substitute the template ID  for a parent ID and retrieve the pattern-words that came before that ID. To do this set  $pat to 1.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> [pattern],[that],[topic].</li>
				<li><span class="field">uses:</span> <a href="../application/_cms_include_retrieve_inc_php.html#functionfindPatternPart">findPatternPart()</a></li>
				<li><span class="field">uses:</span> <a href="../application/_cms_include_common_inc_php.html#functionfindParent">findParent()</a></li>
				<li><span class="field">uses:</span> <a href="../application/_cms_include_common_inc_php.html#functionfindmainnode">findmainnode()</a></li>
			</ul>
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			findCategoryPattern
		</span>
					(<span class="var-type">integer</span>&nbsp;<span class="var-name">$botid</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$templateID</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$pat</span> = <span class="var-default">0</span>])
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$botid</span><span class="var-description">: The bot's ID.</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$templateID</span><span class="var-description">: The category's ID.</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$pat</span><span class="var-description">: To use a parent ID from the pattern table instead of template ID</span>			</li>
				</ul>
		
	
</div>
<a name="functionfindPatternPart" id="functionfindPatternPart"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Function.png" />
		<span class="method-title">findPatternPart</span> (line <span class="line-number"><a href="..//__filesource/fsource_application__cmsincluderetrieve.inc.php.html#a121">121</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the word and the parent ID using the known pattern ID.</p>
<p class="description"><p>Because the word tree is traveled backwards, from leaf-node (i.e. the  template reference) to the trunk (i.e. the &lt;input&gt; node), there needs to  be a reference to the previous word, this is the parent ID in the parent  column. Both the word (including the * and _) and the parent ID are returned.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> 'parent', 'id and 'word'.</li>
				<li><span class="field">usedby:</span> <a href="../application/_cms_include_retrieve_inc_php.html#functionfindCategoryPattern">findCategoryPattern()</a></li>
			</ul>
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			findPatternPart
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$patternID</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$patternID</span><span class="var-description">: The pattern word ID.</span>			</li>
				</ul>
		
	
</div>
		</div>
	</div>
	
	<p class="notes" id="credit">
		Documentation generated on Tue, 11 Jan 2005 18:41:10 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>
Return current item: Program E