update docs and UPGRADE file to 1.6
[phpfspot.git] / docs / phpfspot / PHPFSPOT.html
index 62e09476d34764167332c7b979d0d0128f5c43bd..de4a0f25656c46c2cc77cce443d2029a7f9320d8 100644 (file)
@@ -26,8 +26,9 @@
        <div class="info-box-body">
                        <!-- ========== Info from phpDoc block ========= -->
 <p class="short-description">PHPFSPOT main class</p>
+<p class="description"><p>this class contains the most functions which will to the major  work for phpfspot.</p></p>
                <p class="notes">
-                       Located in <a class="field" href="_phpfspot.class.php.html">/phpfspot.class.php</a> (line <span class="field">33</span>)
+                       Located in <a class="field" href="_phpfspot.class.php.html">/phpfspot.class.php</a> (line <span class="field">36</span>)
                </p>
                
                                
@@ -57,7 +58,7 @@
                                </div>
                                                                                                                                <div class="var-title">
                                        <img src="../media/images/Variable.png" alt=" " />
-                                       <span class="var-type"><a href="../phpfspot/PHPFSPOT_CFG.html">PHPFSPOT_CFG</a></span>
+                                       <span class="var-type">PHPFSPOT_CFG</span>
                                        <a href="#$cfg" title="details" class="var-name">$cfg</a>
                                </div>
                                                                                                                                <div class="var-title">
@@ -96,7 +97,7 @@
                </div>
                <div class="info-box-body">                     
                        <div class="method-summary">
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               <div class="method-definition">
+                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               <div class="method-definition">
                                        <img src="../media/images/Constructor.png" alt=" "/>
                                                                                        <span class="method-result">PHPFSPOT</span>
                                                                                <a href="#__construct" title="details" class="method-name">__construct</a>
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        <span class="method-result">string</span>
                                                                                <a href="#getSelectedTags" title="details" class="method-name">getSelectedTags</a>
-                                                                               ()
+                                                                                       ([<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'link'</span>])
                                                                        </div>
                                                                                                                                <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
                                                                        </div>
                                                                                                                                <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">string</span>
+                                                                               <a href="#get_mime_info" title="details" class="method-name">get_mime_info</a>
+                                                                                       (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        <span class="method-result">integer</span>
                                                                                <a href="#get_num_photos" title="details" class="method-name">get_num_photos</a>
                                                                                        (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
                                                                        </div>
                                                                                                                                <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">integer</span>
+                                                                               <a href="#get_photo_rating" title="details" class="method-name">get_photo_rating</a>
+                                                                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        <span class="method-result">array</span>
                                                                                <a href="#get_random_photo" title="details" class="method-name">get_random_photo</a>
                                                                                ()
                                                                        </div>
                                                                                                                                <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">array</span>
+                                                                               <a href="#get_random_tag_photo" title="details" class="method-name">get_random_tag_photo</a>
+                                                                                       (<span class="var-type"></span>&nbsp;<span class="var-name">$tagidx</span>)
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">string</span>
+                                                                               <a href="#get_rate_search" title="details" class="method-name">get_rate_search</a>
+                                                                               ()
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">string</span>
+                                                                               <a href="#get_tag_name" title="details" class="method-name">get_tag_name</a>
+                                                                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        <span class="method-result">string</span>
                                                                                <a href="#get_thumb_path" title="details" class="method-name">get_thumb_path</a>
                                                                                ()
                                                                        </div>
                                                                                                                                <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">void</span>
+                                                                               <a href="#resetRateSearch" title="details" class="method-name">resetRateSearch</a>
+                                                                               ()
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        <span class="method-result">void</span>
                                                                                <a href="#resetSlideShow" title="details" class="method-name">resetSlideShow</a>
                                                                        </div>
                                                                                                                                <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
-                                                                                       <span class="method-result">void</span>
+                                                                                       <span class="method-result">string</span>
                                                                                <a href="#showPhotoIndex" title="details" class="method-name">showPhotoIndex</a>
                                                                                ()
                                                                        </div>
                <span class="var-title">
                        <span class="var-type">array</span>
                        <span class="var-name">$avail_tags</span>
-                                               (line <span class="line-number">80</span>)
+                                               (line <span class="line-number">83</span>)
                </span>
        </div>
 
        <div class="var-header">
                <img src="../media/images/Variable.png" />
                <span class="var-title">
-                       <span class="var-type"><a href="../phpfspot/PHPFSPOT_CFG.html">PHPFSPOT_CFG</a></span>
+                       <span class="var-type">PHPFSPOT_CFG</span>
                        <span class="var-name">$cfg</span>
-                                               (line <span class="line-number">41</span>)
+                                               (line <span class="line-number">44</span>)
                </span>
        </div>
 
                <span class="var-title">
                        <span class="var-type"><a href="../phpfspot/PHPFSPOT_DB.html">PHPFSPOT_DB</a></span>
                        <span class="var-name">$cfg_db</span>
-                                               (line <span class="line-number">57</span>)
+                                               (line <span class="line-number">60</span>)
                </span>
        </div>
 
                <span class="var-title">
                        <span class="var-type"><a href="../phpfspot/PHPFSPOT_DB.html">PHPFSPOT_DB</a></span>
                        <span class="var-name">$db</span>
-                                               (line <span class="line-number">49</span>)
+                                               (line <span class="line-number">52</span>)
                </span>
        </div>
 
                <span class="var-title">
                        <span class="var-type">array</span>
                        <span class="var-name">$tags</span>
-                                               (line <span class="line-number">73</span>)
+                                               (line <span class="line-number">76</span>)
                </span>
        </div>
 
                <span class="var-title">
                        <span class="var-type"><a href="../phpfspot/PHPFSPOT_TMPL.html">PHPFSPOT_TMPL</a></span>
                        <span class="var-name">$tmpl</span>
-                                               (line <span class="line-number">66</span>)
+                                               (line <span class="line-number">69</span>)
                </span>
        </div>
 
        
        <div class="method-header">
                <img src="../media/images/Constructor.png" />
-               <span class="method-title">Constructor __construct</span> (line <span class="line-number">103</span>)
+               <span class="method-title">Constructor __construct</span> (line <span class="line-number">106</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Destructor.png" />
-               <span class="method-title">Destructor __destruct</span> (line <span class="line-number">223</span>)
+               <span class="method-title">Destructor __destruct</span> (line <span class="line-number">248</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">addTag</span> (line <span class="line-number">759</span>)
+               <span class="method-title">addTag</span> (line <span class="line-number">953</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">checkifImageSupported</span> (line <span class="line-number">1976</span>)
+               <span class="method-title">checkifImageSupported</span> (line <span class="line-number">2350</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">check_config_table</span> (line <span class="line-number">1515</span>)
+               <span class="method-title">check_config_table</span> (line <span class="line-number">1846</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">cleanup_phpfspot_db</span> (line <span class="line-number">2742</span>)
+               <span class="method-title">cleanup_phpfspot_db</span> (line <span class="line-number">3215</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">create_thumbnail</span> (line <span class="line-number">1348</span>)
+               <span class="method-title">create_thumbnail</span> (line <span class="line-number">1599</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">create_thumbnails for the requested width</p>
+<p class="short-description">create thumbnails for the requested width</p>
 <p class="description"><p>this function creates image thumbnails of $orig_image  stored as $thumb_image. It will check if the image is  in a supported format, if necessary rotate the image  (based on EXIF orientation meta headers) and re-sizing.</p></p>
        <ul class="tags">
                                <li><span class="field">access:</span> public</li>
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">delTag</span> (line <span class="line-number">783</span>)
+               <span class="method-title">delTag</span> (line <span class="line-number">982</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">gen_thumb</span> (line <span class="line-number">1543</span>)
+               <span class="method-title">gen_thumb</span> (line <span class="line-number">1874</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getAvailableTags</span> (line <span class="line-number">642</span>)
+               <span class="method-title">getAvailableTags</span> (line <span class="line-number">806</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getCurrentPhoto</span> (line <span class="line-number">2253</span>)
+               <span class="method-title">getCurrentPhoto</span> (line <span class="line-number">2645</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getExport</span> (line <span class="line-number">2122</span>)
+               <span class="method-title">getExport</span> (line <span class="line-number">2502</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getFspotDBVersion</span> (line <span class="line-number">2613</span>)
+               <span class="method-title">getFspotDBVersion</span> (line <span class="line-number">3084</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getMD5</span> (line <span class="line-number">1627</span>)
+               <span class="method-title">getMD5</span> (line <span class="line-number">1976</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getNextSlideShowImage</span> (line <span class="line-number">2370</span>)
+               <span class="method-title">getNextSlideShowImage</span> (line <span class="line-number">2765</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getPhotoName</span> (line <span class="line-number">451</span>)
+               <span class="method-title">getPhotoName</span> (line <span class="line-number">538</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
 <p class="short-description">returns aligned photo names</p>
-<p class="description"><p>this function returns aligned (length) names for  an specific photo. If the length of the name exceeds  $limit the name will be shrinked (...)</p></p>
+<p class="description"><p>this function returns aligned (length) names for a specific photo.  If the length of the name exceeds $limit the name will bei  shrinked (...).</p></p>
        <ul class="tags">
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getPhotoSelection</span> (line <span class="line-number">924</span>)
+               <span class="method-title">getPhotoSelection</span> (line <span class="line-number">1136</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getPrevSlideShowImage</span> (line <span class="line-number">2390</span>)
+               <span class="method-title">getPrevSlideShowImage</span> (line <span class="line-number">2789</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getRSSFeed</span> (line <span class="line-number">2164</span>)
+               <span class="method-title">getRSSFeed</span> (line <span class="line-number">2549</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getSelectedTags</span> (line <span class="line-number">726</span>)
+               <span class="method-title">getSelectedTags</span> (line <span class="line-number">905</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                <span class="method-name">
                        getSelectedTags
                </span>
-                               ()
+                                       ([<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'link'</span>])
                        </div>
        
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type"></span>
+                               <span class="var-name">$type</span>                     </li>
+                               </ul>
                
                        
        </div>
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_calendar_matrix</span> (line <span class="line-number">2043</span>)
+               <span class="method-title">get_calendar_matrix</span> (line <span class="line-number">2423</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_meta_informations</span> (line <span class="line-number">1502</span>)
+               <span class="method-title">get_meta_informations</span> (line <span class="line-number">1833</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                
                        
        </div>
-<a name="methodget_num_photos" id="get_num_photos"><!-- --></a>
+<a name="methodget_mime_info" id="get_mime_info"><!-- --></a>
 <div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_num_photos</span> (line <span class="line-number">2542</span>)
+               <span class="method-title">get_mime_info</span> (line <span class="line-number">3276</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">return mime info</p>
+<p class="description"><p>this function tries to find out the correct mime-type  for the provided file.</p></p>
+       <ul class="tags">
+                               <li><span class="field">access:</span> public</li>
+                       </ul>
+       
+       <div class="method-signature">
+               <span class="method-result">string</span>
+               <span class="method-name">
+                       get_mime_info
+               </span>
+                                       (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
+                       </div>
+       
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type">string</span>
+                               <span class="var-name">$file</span>                     </li>
+                               </ul>
+               
+                       
+       </div>
+<a name="methodget_num_photos" id="get_num_photos"><!-- --></a>
+<div class="evenrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">get_num_photos</span> (line <span class="line-number">3013</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodget_photo_details" id="get_photo_details"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_photo_details</span> (line <span class="line-number">392</span>)
+               <span class="method-title">get_photo_details</span> (line <span class="line-number">465</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                                </ul>
                
                        
+       </div>
+<a name="methodget_photo_rating" id="get_photo_rating"><!-- --></a>
+<div class="evenrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">get_photo_rating</span> (line <span class="line-number">562</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">get photo rating level</p>
+<p class="description"><p>this function will return the integer-based rating level of a  photo. This can only be done, if the F-Spot database is at a  specific version. If rating value can not be found, zero will  be returned indicating no rating value is available.</p></p>
+       <ul class="tags">
+                               <li><span class="field">access:</span> public</li>
+                       </ul>
+       
+       <div class="method-signature">
+               <span class="method-result">integer</span>
+               <span class="method-name">
+                       get_photo_rating
+               </span>
+                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
+                       </div>
+       
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type">integer</span>
+                               <span class="var-name">$idx</span><span class="var-description">: idx</span>                    </li>
+                               </ul>
+               
+                       
        </div>
 <a name="methodget_random_photo" id="get_random_photo"><!-- --></a>
 <div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_random_photo</span> (line <span class="line-number">2421</span>)
+               <span class="method-title">get_random_photo</span> (line <span class="line-number">2824</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                
                        
        </div>
-<a name="methodget_thumb_path" id="get_thumb_path"><!-- --></a>
+<a name="methodget_random_tag_photo" id="get_random_tag_photo"><!-- --></a>
+<div class="evenrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">get_random_tag_photo</span> (line <span class="line-number">2867</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">get random photo tag photo</p>
+<p class="description"><p>this function will get all photos tagged with the requested  tag from the fspot database and randomly return ONE entry</p><p>saddly there is yet no sqlite3 function which returns  the bulk result in array, so we have to fill up our  own here.</p></p>
+       <ul class="tags">
+                               <li><span class="field">access:</span> public</li>
+                       </ul>
+       
+       <div class="method-signature">
+               <span class="method-result">array</span>
+               <span class="method-name">
+                       get_random_tag_photo
+               </span>
+                                       (<span class="var-type"></span>&nbsp;<span class="var-name">$tagidx</span>)
+                       </div>
+       
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type"></span>
+                               <span class="var-name">$tagidx</span>                   </li>
+                               </ul>
+               
+                       
+       </div>
+<a name="methodget_rate_search" id="get_rate_search"><!-- --></a>
+<div class="oddrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">get_rate_search</span> (line <span class="line-number">580</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">get rate-search bars</p>
+<p class="description"><p>this function will return the rating-bars for the search field.</p></p>
+       <ul class="tags">
+                               <li><span class="field">access:</span> public</li>
+                       </ul>
+       
+       <div class="method-signature">
+               <span class="method-result">string</span>
+               <span class="method-name">
+                       get_rate_search
+               </span>
+                               ()
+                       </div>
+       
+               
+                       
+       </div>
+<a name="methodget_tag_name" id="get_tag_name"><!-- --></a>
 <div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_thumb_path</span> (line <span class="line-number">2493</span>)
+               <span class="method-title">get_tag_name</span> (line <span class="line-number">3303</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">return tag-name by tag-idx</p>
+<p class="description"><p>this function returns the tag-name for the requested  tag specified by tag-idx.</p></p>
+       <ul class="tags">
+                               <li><span class="field">access:</span> public</li>
+                       </ul>
+       
+       <div class="method-signature">
+               <span class="method-result">string</span>
+               <span class="method-name">
+                       get_tag_name
+               </span>
+                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
+                       </div>
+       
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type">integer</span>
+                               <span class="var-name">$idx</span>                      </li>
+                               </ul>
+               
+                       
+       </div>
+<a name="methodget_thumb_path" id="get_thumb_path"><!-- --></a>
+<div class="oddrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">get_thumb_path</span> (line <span class="line-number">2963</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodget_xml_tag_list" id="get_xml_tag_list"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_xml_tag_list</span> (line <span class="line-number">815</span>)
+               <span class="method-title">get_xml_tag_list</span> (line <span class="line-number">1014</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">returns the value for the autocomplet tag-search</p>
+<p class="short-description">returns the value for the autocomplete tag-search</p>
        <ul class="tags">
                                <li><span class="field">access:</span> public</li>
                        </ul>
                        
        </div>
 <a name="methodisValidDate" id="isValidDate"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">isValidDate</span> (line <span class="line-number">2447</span>)
+               <span class="method-title">isValidDate</span> (line <span class="line-number">2915</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodparse_uri" id="parse_uri"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">parse_uri</span> (line <span class="line-number">2633</span>)
+               <span class="method-title">parse_uri</span> (line <span class="line-number">3104</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodresetDateSearch" id="resetDateSearch"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetDateSearch</span> (line <span class="line-number">906</span>)
+               <span class="method-title">resetDateSearch</span> (line <span class="line-number">1104</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
 <p class="short-description">reset date search</p>
-<p class="description"><p>if any date search has taken place, reset  it now</p></p>
+<p class="description"><p>if any date search has taken place, reset it now.</p></p>
        <ul class="tags">
                                <li><span class="field">access:</span> public</li>
                        </ul>
                        
        </div>
 <a name="methodresetNameSearch" id="resetNameSearch"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetNameSearch</span> (line <span class="line-number">893</span>)
+               <span class="method-title">resetNameSearch</span> (line <span class="line-number">1092</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodresetPhotoView" id="resetPhotoView"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetPhotoView</span> (line <span class="line-number">869</span>)
+               <span class="method-title">resetPhotoView</span> (line <span class="line-number">1068</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
                
                        
+       </div>
+<a name="methodresetRateSearch" id="resetRateSearch"><!-- --></a>
+<div class="evenrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">resetRateSearch</span> (line <span class="line-number">1118</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">reset rate search</p>
+<p class="description"><p>if any rate search has taken place, reset it now.</p></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">
+                       resetRateSearch
+               </span>
+                               ()
+                       </div>
+       
+               
+                       
        </div>
 <a name="methodresetSlideShow" id="resetSlideShow"><!-- --></a>
 <div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetSlideShow</span> (line <span class="line-number">2403</span>)
+               <span class="method-title">resetSlideShow</span> (line <span class="line-number">2806</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetTags</span> (line <span class="line-number">804</span>)
+               <span class="method-title">resetTags</span> (line <span class="line-number">1003</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetTagSearch</span> (line <span class="line-number">881</span>)
+               <span class="method-title">resetTagSearch</span> (line <span class="line-number">1080</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">setTagCondition</span> (line <span class="line-number">1665</span>)
+               <span class="method-title">setTagCondition</span> (line <span class="line-number">2014</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">show</span> (line <span class="line-number">237</span>)
+               <span class="method-title">show</span> (line <span class="line-number">262</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">showCredits</span> (line <span class="line-number">1327</span>)
+               <span class="method-title">showCredits</span> (line <span class="line-number">1578</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">showPhoto</span> (line <span class="line-number">506</span>)
+               <span class="method-title">showPhoto</span> (line <span class="line-number">662</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">showPhotoIndex</span> (line <span class="line-number">1128</span>)
+               <span class="method-title">showPhotoIndex</span> (line <span class="line-number">1365</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        </ul>
        
        <div class="method-signature">
-               <span class="method-result">void</span>
+               <span class="method-result">string</span>
                <span class="method-name">
                        showPhotoIndex
                </span>
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">showTextImage</span> (line <span class="line-number">1890</span>)
+               <span class="method-title">showTextImage</span> (line <span class="line-number">2264</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">smarty_sort_select_list</span> (line <span class="line-number">2308</span>)
+               <span class="method-title">smarty_sort_select_list</span> (line <span class="line-number">2697</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">startSearch</span> (line <span class="line-number">1683</span>)
+               <span class="method-title">startSearch</span> (line <span class="line-number">2032</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">translate_path</span> (line <span class="line-number">493</span>)
+               <span class="method-title">translate_path</span> (line <span class="line-number">649</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">updateSortOrder</span> (line <span class="line-number">1735</span>)
+               <span class="method-title">updateSortOrder</span> (line <span class="line-number">2106</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">whatToDo</span> (line <span class="line-number">2270</span>)
+               <span class="method-title">whatToDo</span> (line <span class="line-number">2662</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">_error</span> (line <span class="line-number">1989</span>)
+               <span class="method-title">_error</span> (line <span class="line-number">2370</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
 
        
        <p class="notes" id="credit">
-               Documentation generated on Sat, 12 Apr 2008 18:24:57 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+               Documentation generated on Wed, 02 Jul 2008 20:40:55 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
        </p>
        </div></body>
 </html>
\ No newline at end of file