Location: PHPKode > projects > Program E > docs/developer/__filesource/fsource_application__cmsincluderetrieve.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>File Source for retrieve.inc.php</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
											</head>
		<body>
						
<h1>Source for file retrieve.inc.php</h1>
<p>Documentation is available at <a href="../application/_cms_include_retrieve_inc_php.html">retrieve.inc.php</a></p>
<div class="src-code">
<pre><ol><li><a name="a1"></a><span class="src-php">&lt;?php</span></li>
<li><a name="a2"></a>&nbsp;</li>
<li><a name="a3"></a><span class="src-comm">/*</span></li>
<li><a name="a4"></a><span class="src-comm">    Program E related AIML knowledgebase tools</span></li>
<li><a name="a5"></a><span class="src-comm">    Copyright 2004, Anne Kootstra [hide@address.com]</span></li>
<li><a name="a6"></a><span class="src-comm">    http://www.AIML.info</span></li>
<li><a name="a7"></a>    </li>
<li><a name="a8"></a><span class="src-comm">    Program E is free software; you can redistribute it and/or modify</span></li>
<li><a name="a9"></a><span class="src-comm">    it under the terms of the GNU General Public License as published by</span></li>
<li><a name="a10"></a><span class="src-comm">    the Free Software Foundation; either version 2 of the License, or</span></li>
<li><a name="a11"></a><span class="src-comm">    (at your option) any later version.</span></li>
<li><a name="a12"></a>&nbsp;</li>
<li><a name="a13"></a><span class="src-comm">    Program E is distributed in the hope that it will be useful,</span></li>
<li><a name="a14"></a><span class="src-comm">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span></li>
<li><a name="a15"></a><span class="src-comm">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span></li>
<li><a name="a16"></a><span class="src-comm">    GNU General Public License for more details.</span></li>
<li><a name="a17"></a>&nbsp;</li>
<li><a name="a18"></a><span class="src-comm">    You should have received a copy of the GNU General Public License</span></li>
<li><a name="a19"></a><span class="src-comm">    along with Program E; if not, write to the Free Software</span></li>
<li><a name="a20"></a><span class="src-comm">    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</span></li>
<li><a name="a21"></a><span class="src-comm">*/</span></li>
<li><a name="a22"></a>&nbsp;</li>
<li><a name="a23"></a>&nbsp;</li>
<li><a name="a24"></a><span class="src-doc">/**</span></li>
<li><a name="a25"></a><span class="src-doc">* Given a specific template ID retrieve the corresponding PATTERN,</span></li>
<li><a name="a26"></a><span class="src-doc">* THAT and TOPIC.</span></li>
<li><a name="a27"></a><span class="src-doc">*</span></li>
<li><a name="a28"></a><span class="src-doc">* Retrieve the Pattern, That and Topic using only the ID of the corresponding template.</span></li>
<li><a name="a29"></a><span class="src-doc">* This function has also been adapted to make it possible to substitute the template ID</span></li>
<li><a name="a30"></a><span class="src-doc">* for a parent ID and retrieve the pattern-words that came before that ID. To do this set</span></li>
<li><a name="a31"></a><span class="src-doc">* $pat to 1.</span></li>
<li><a name="a32"></a><span class="src-doc">*</span></li>
<li><a name="a33"></a><span class="src-doc">* </span><span class="src-doc-coretag">@uses</span><span class="src-doc"> findmainnode()</span></li>
<li><a name="a34"></a><span class="src-doc">* </span><span class="src-doc-coretag">@uses</span><span class="src-doc"> findParent()</span></li>
<li><a name="a35"></a><span class="src-doc">* </span><span class="src-doc-coretag">@uses</span><span class="src-doc"> findPatternPart()</span></li>
<li><a name="a36"></a><span class="src-doc">*</span></li>
<li><a name="a37"></a><span class="src-doc">* </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$botid </span><span class="src-doc">             The bot's ID.</span></li>
<li><a name="a38"></a><span class="src-doc">* </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$templateID </span><span class="src-doc">        The category's ID.</span></li>
<li><a name="a39"></a><span class="src-doc">* </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">boolean </span><span class="src-doc-var">$pat </span><span class="src-doc">               To use a parent ID from the pattern table instead of template ID</span></li>
<li><a name="a40"></a><span class="src-doc">* </span></li>
<li><a name="a41"></a><span class="src-doc">* </span><span class="src-doc-tag">@returns</span><span class="src-doc"> array                      [pattern],[that],[topic].</span></li>
<li><a name="a42"></a><span class="src-doc">*/</span></li>
<li><a name="a43"></a><span class="src-key">function </span><a href="../application/_cms_include_retrieve_inc_php.html#functionfindCategoryPattern">findCategoryPattern</a><span class="src-sym">(</span><span class="src-var">$botid</span><span class="src-sym">, </span><span class="src-var">$templateID</span><span class="src-sym">, </span><span class="src-var">$pat</span>=<span class="src-num">0</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
<li><a name="a44"></a>&nbsp;</li>
<li><a name="a45"></a>        /**</li>
<li><a name="a46"></a>         * @var array contains the final pattern</li>
<li><a name="a47"></a>        */</li>
<li><a name="a48"></a>         <span class="src-var">$final_pattern</span><span class="src-sym">;</span></li>
<li><a name="a49"></a>        </li>
<li><a name="a50"></a>        <span class="src-comm">// retrieve the pattern ID of the main node</span></li>
<li><a name="a51"></a>        <span class="src-var">$mainNode</span>= <a href="../application/_cms_include_common_inc_php.html#functionfindmainnode">findmainnode</a><span class="src-sym">(</span><span class="src-var">$botid</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><a name="a52"></a>        </li>
<li><a name="a53"></a>        <span class="src-key">if</span><span class="src-sym">(</span><span class="src-var">$pat</span>==<span class="src-num">0</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
<li><a name="a54"></a>            <span class="src-comm">// retrieve the corresponding parentID i.e. next word's patternID.</span></li>
<li><a name="a55"></a>            <span class="src-var">$pattern_parent </span>= <a href="../application/_cms_include_common_inc_php.html#functionfindParent">findParent</a><span class="src-sym">(</span><span class="src-var">$templateID</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><a name="a56"></a>        <span class="src-sym">}</span><span class="src-key">elseif</span><span class="src-sym">(</span><span class="src-var">$pat</span>==<span class="src-num">1</span><span class="src-sym">)</span><span class="src-sym">{</span></li>
<li><a name="a57"></a>            <span class="src-var">$pattern_parent </span>= <span class="src-var">$templateID</span><span class="src-sym">;</span></li>
<li><a name="a58"></a>        <span class="src-sym">}</span></li>
<li><a name="a59"></a>        </li>
<li><a name="a60"></a>        <span class="src-comm">// storage for this category's pattern, that and topic</span></li>
<li><a name="a61"></a>        <span class="src-var">$final_pattern </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><a name="a62"></a>        <span class="src-var">$final_word_index </span>= <span class="src-num">0</span><span class="src-sym">;</span></li>
<li><a name="a63"></a>&nbsp;</li>
<li><a name="a64"></a>        </li>
<li><a name="a65"></a>        <span class="src-comm">// loop ends when the path from the leaf node (template reference) </span></li>
<li><a name="a66"></a>        <span class="src-comm">// to the main node (i.e. &lt;input&gt;) is completely walked. </span></li>
<li><a name="a67"></a>        <span class="src-key">while</span><span class="src-sym">(</span><span class="src-var">$mainNode </span>&lt;= <span class="src-var">$pattern_parent</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
<li><a name="a68"></a>               </li>
<li><a name="a69"></a>               <span class="src-comm">// collect the current word, and next word's pattern ID</span></li>
<li><a name="a70"></a>               <span class="src-var">$pattern_details </span>= <a href="../application/_cms_include_retrieve_inc_php.html#functionfindPatternPart">findPatternPart</a><span class="src-sym">(</span><span class="src-var">$pattern_parent</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><a name="a71"></a>               </li>
<li><a name="a72"></a>               <span class="src-comm">// save current word into a seperate array element</span></li>
<li><a name="a73"></a>               <span class="src-var">$final_pattern</span><span class="src-sym">[</span><span class="src-var">$final_word_index</span><span class="src-sym">] </span>= <span class="src-var">$pattern_details</span><span class="src-sym">[</span><span class="src-str">'word'</span><span class="src-sym">]</span><span class="src-sym">;</span></li>
<li><a name="a74"></a>               <span class="src-var">$final_word_index</span>++<span class="src-sym">;</span></li>
<li><a name="a75"></a>               </li>
<li><a name="a76"></a>               <span class="src-comm">// set up for processing next word.</span></li>
<li><a name="a77"></a>               <span class="src-var">$pattern_parent </span>= <span class="src-var">$pattern_details</span><span class="src-sym">[</span><span class="src-str">'parent'</span><span class="src-sym">]</span><span class="src-sym">;</span></li>
<li><a name="a78"></a>        <span class="src-sym">}</span></li>
<li><a name="a79"></a>&nbsp;</li>
<li><a name="a80"></a>        <span class="src-comm">// the tree is walked backwards, so the category's pattern</span></li>
<li><a name="a81"></a>        <span class="src-comm">// is also stored into the array backwards, This reverses is.</span></li>
<li><a name="a82"></a>        <span class="src-var">$final_pattern_reverse </span>= <a href="http://www.php.net/array_reverse">array_reverse</a><span class="src-sym">(</span><span class="src-var">$final_pattern</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><a name="a83"></a>        </li>
<li><a name="a84"></a>        </li>
<li><a name="a85"></a>        <span class="src-comm">// process each individual word and put them into one of</span></li>
<li><a name="a86"></a>        <span class="src-comm">// [pattern], [that] or [topic] array elements.</span></li>
<li><a name="a87"></a>        <span class="src-key">while </span><span class="src-sym">(</span>list<span class="src-sym">(</span><span class="src-var">$key</span><span class="src-sym">, </span><span class="src-var">$val</span><span class="src-sym">) </span>= <a href="http://www.php.net/each">each</a><span class="src-sym">(</span><span class="src-var">$final_pattern_reverse</span><span class="src-sym">)) </span><span class="src-sym">{</span></li>
<li><a name="a88"></a>        </li>
<li><a name="a89"></a>              <span class="src-key">if</span><span class="src-sym">(</span><span class="src-var">$val </span>== <span class="src-str">&quot;&lt;input&gt;&quot;</span><span class="src-sym">)</span><span class="src-sym">{</span></li>
<li><a name="a90"></a>                 <span class="src-var">$cat_section </span>= <span class="src-str">&quot;pattern&quot;</span><span class="src-sym">;</span></li>
<li><a name="a91"></a>              <span class="src-sym">}</span><span class="src-key">elseif</span><span class="src-sym">(</span><span class="src-var">$val </span>== <span class="src-str">&quot;&lt;that&gt;&quot;</span><span class="src-sym">)</span><span class="src-sym">{</span></li>
<li><a name="a92"></a>                      <span class="src-var">$cat_section </span>= <span class="src-str">&quot;that&quot;</span><span class="src-sym">;</span></li>
<li><a name="a93"></a>              <span class="src-sym">}</span><span class="src-key">elseif</span><span class="src-sym">(</span><span class="src-var">$val </span>== <span class="src-str">&quot;&lt;topic&gt;&quot;</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
<li><a name="a94"></a>                      <span class="src-var">$cat_section </span>= <span class="src-str">&quot;topic&quot;</span><span class="src-sym">;</span></li>
<li><a name="a95"></a>              <span class="src-sym">}</span></li>
<li><a name="a96"></a>&nbsp;</li>
<li><a name="a97"></a>            <span class="src-key">if</span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-sym">(</span><span class="src-var">$val</span>==<span class="src-str">&quot;&lt;input&gt;&quot; </span>|| <span class="src-var">$val</span>==<span class="src-str">&quot;&lt;that&gt;&quot; </span>|| <span class="src-var">$val</span>==<span class="src-str">&quot;&lt;topic&gt;&quot;</span><span class="src-sym">)) </span><span class="src-sym">{</span></li>
<li><a name="a98"></a>              <span class="src-var">$final_category</span><span class="src-sym">[</span><span class="src-var">$cat_section</span><span class="src-sym">] </span>.= <span class="src-var">$val</span>.<span class="src-str">&quot; &quot;</span><span class="src-sym">;</span></li>
<li><a name="a99"></a>             <span class="src-sym">}</span></li>
<li><a name="a100"></a>&nbsp;</li>
<li><a name="a101"></a>        <span class="src-sym">}</span></li>
<li><a name="a102"></a>        <span class="src-comm">// return the completed three piece array.</span></li>
<li><a name="a103"></a>        <span class="src-key">return </span><span class="src-var">$final_category</span><span class="src-sym">;</span></li>
<li><a name="a104"></a>&nbsp;</li>
<li><a name="a105"></a><span class="src-sym">}</span></li>
<li><a name="a106"></a>&nbsp;</li>
<li><a name="a107"></a>&nbsp;</li>
<li><a name="a108"></a><span class="src-doc">/**</span></li>
<li><a name="a109"></a><span class="src-doc">* Get the word and the parent ID using the known pattern ID.</span></li>
<li><a name="a110"></a><span class="src-doc">*</span></li>
<li><a name="a111"></a><span class="src-doc">* Because the word tree is traveled backwards, from leaf-node (i.e. the</span></li>
<li><a name="a112"></a><span class="src-doc">* template reference) to the trunk (i.e. the &lt;input&gt; node), there needs to</span></li>
<li><a name="a113"></a><span class="src-doc">* be a reference to the previous word, this is the parent ID in the parent</span></li>
<li><a name="a114"></a><span class="src-doc">* column. Both the word (including the * and _) and the parent ID are returned.</span></li>
<li><a name="a115"></a><span class="src-doc">*</span></li>
<li><a name="a116"></a><span class="src-doc">* </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$patternID </span><span class="src-doc">         The pattern word ID.</span></li>
<li><a name="a117"></a><span class="src-doc">* </span></li>
<li><a name="a118"></a><span class="src-doc">* </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span><span class="src-doc">                    'parent', 'id and 'word'.</span></li>
<li><a name="a119"></a><span class="src-doc">*</span></li>
<li><a name="a120"></a><span class="src-doc">*/</span></li>
<li><a name="a121"></a><span class="src-key">function </span><a href="../application/_cms_include_retrieve_inc_php.html#functionfindPatternPart">findPatternPart</a><span class="src-sym">(</span><span class="src-var">$patternID</span><span class="src-sym">)</span><span class="src-sym">{</span></li>
<li><a name="a122"></a>&nbsp;</li>
<li><a name="a123"></a>    <span class="src-comm">/* </span></li>
<li><a name="a124"></a><span class="src-comm">      The ordera column in the pattern table is used to identify </span></li>
<li><a name="a125"></a><span class="src-comm">      the order of the 'word' in the matching process. An underscore</span></li>
<li><a name="a126"></a><span class="src-comm">      has the order value of 1, a word (atomic match) of 2 and the</span></li>
<li><a name="a127"></a><span class="src-comm">      * has a value of 3. This fact is used to recreate those values.</span></li>
<li><a name="a128"></a><span class="src-comm">    */</span></li>
<li><a name="a129"></a>    <span class="src-var">$query </span>= <span class="src-str">&quot;select ifnull(if(word='&lt;input&gt;','AIML ROOT',word),if(ordera='1','_','*')) as word, parent, id from patterns where id = &quot;</span>.<span class="src-var">$patternID</span>.<span class="src-str">&quot;&quot;</span><span class="src-sym">;</span></li>
<li><a name="a130"></a>    <span class="src-comm">//debugger($query,2);</span></li>
<li><a name="a131"></a>    <span class="src-var">$selectcode </span>= <a href="http://www.php.net/mysql_query">mysql_query</a><span class="src-sym">(</span><span class="src-var">$query</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><a name="a132"></a>    <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$selectcode</span><span class="src-sym">)</span><span class="src-sym">{</span></li>
<li><a name="a133"></a>        <span class="src-key">if</span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/mysql_numrows">mysql_numrows</a><span class="src-sym">(</span><span class="src-var">$selectcode</span><span class="src-sym">))</span><span class="src-sym">{</span></li>
<li><a name="a134"></a>            <span class="src-key">return </span><span class="src-str">&quot;&quot;</span><span class="src-sym">;</span></li>
<li><a name="a135"></a>        <span class="src-sym">}</span></li>
<li><a name="a136"></a>        <span class="src-key">else</span><span class="src-sym">{</span></li>
<li><a name="a137"></a>            <span class="src-key">while </span><span class="src-sym">(</span><span class="src-var">$q </span>= <a href="http://www.php.net/mysql_fetch_array">mysql_fetch_array</a><span class="src-sym">(</span><span class="src-var">$selectcode</span><span class="src-sym">))</span><span class="src-sym">{</span></li>
<li><a name="a138"></a>                <span class="src-var">$pattern</span><span class="src-sym">[</span><span class="src-str">'word'</span><span class="src-sym">] </span>= <span class="src-var">$q</span><span class="src-sym">[</span><span class="src-num">0</span><span class="src-sym">]</span><span class="src-sym">;</span></li>
<li><a name="a139"></a>                <span class="src-var">$pattern</span><span class="src-sym">[</span><span class="src-str">'parent'</span><span class="src-sym">] </span>= <span class="src-var">$q</span><span class="src-sym">[</span><span class="src-num">1</span><span class="src-sym">]</span><span class="src-sym">;</span></li>
<li><a name="a140"></a>                <span class="src-var">$pattern</span><span class="src-sym">[</span><span class="src-str">'id'</span><span class="src-sym">] </span>= <span class="src-var">$q</span><span class="src-sym">[</span><span class="src-num">2</span><span class="src-sym">]</span><span class="src-sym">;</span></li>
<li><a name="a141"></a>                <span class="src-key">return </span><span class="src-var">$pattern</span><span class="src-sym">;</span></li>
<li><a name="a142"></a>            <span class="src-sym">}</span></li>
<li><a name="a143"></a>        <span class="src-sym">}</span></li>
<li><a name="a144"></a>    <span class="src-sym">}</span></li>
<li><a name="a145"></a>&nbsp;</li>
<li><a name="a146"></a>    <span class="src-key">return </span><span class="src-str">&quot;&quot;</span><span class="src-sym">;</span></li>
<li><a name="a147"></a><span class="src-sym">}</span></li>
<li><a name="a148"></a>&nbsp;</li>
<li><a name="a149"></a><span class="src-php">?&gt;</span></li>
</ol></pre>
</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>
	</body>
</html>
Return current item: Program E