fixed path problem (missing "/")
[phpfspot.git] / docs / phpfspot / PHPFSPOT.html
index 33c8cb50f256370e37e049a80cab87943d431d5e..5131ab28ed7d77c26632733c6ede6a2363b1652c 100644 (file)
@@ -97,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>
                                                                                                                                <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        <span class="method-result">void</span>
-                                                                               <a href="#check_config_table" title="details" class="method-name">check_config_table</a>
+                                                                               <a href="#check_phpfspot_db" title="details" class="method-name">check_phpfspot_db</a>
                                                                                ()
                                                                        </div>
                                                                                                                                <div class="method-definition">
                                                                                ()
                                                                        </div>
                                                                                                                                <div class="method-definition">
-                                       <img src="../media/images/Method.png" alt=" "/>
-                                                                                       <span class="method-result">void</span>
-                                                                               <a href="#getCurrentPhoto" title="details" class="method-name">getCurrentPhoto</a>
-                                                                               ()
-                                                                       </div>
-                                                                                                                               <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        <span class="method-result">void</span>
                                                                                <a href="#getExport" title="details" class="method-name">getExport</a>
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        <span class="method-result">string|null</span>
                                                                                <a href="#getMD5" title="details" class="method-name">getMD5</a>
-                                                                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
+                                                                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$version_idx</span> = <span class="var-default">0</span>])
                                                                        </div>
                                                                                                                                <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
                                        <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="method-result">void</span>
                                                                                <a href="#get_calendar_matrix" title="details" class="method-name">get_calendar_matrix</a>
-                                                                                       ([<span class="var-type">integer</span>&nbsp;<span class="var-name">$year</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$month</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$day</span> = <span class="var-default">0</span>])
+                                                                                       (<span class="var-type"></span>&nbsp;<span class="var-name">$userdate</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$year</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$month</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$day</span>)
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">void</span>
+                                                                               <a href="#get_current_photo" title="details" class="method-name">get_current_photo</a>
+                                                                               ()
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">int</span>
+                                                                               <a href="#get_current_version" title="details" class="method-name">get_current_version</a>
+                                                                               ()
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">integer</span>
+                                                                               <a href="#get_db_version" title="details" class="method-name">get_db_version</a>
+                                                                               ()
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">int</span>
+                                                                               <a href="#get_latest_version" title="details" class="method-name">get_latest_version</a>
+                                                                                       (<span class="var-type"></span>&nbsp;<span class="var-name">$photo_idx</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>
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        <span class="method-result">object|null</span>
                                                                                <a href="#get_photo_details" title="details" class="method-name">get_photo_details</a>
+                                                                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$version_idx</span> = <span class="var-default">NULL</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_photo_versions" title="details" class="method-name">get_photo_versions</a>
+                                                                                       (<span class="var-type">int</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_photo_version_name" title="details" class="method-name">get_photo_version_name</a>
+                                                                                       (<span class="var-type">int</span>&nbsp;<span class="var-name">$photo_idx</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$version_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>
-                                                                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$width</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$photo</span>)
+                                                                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$width</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$photo_idx</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$version_idx</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$photo</span>)
                                                                        </div>
                                                                                                                                <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$date_str</span>)
                                                                        </div>
                                                                                                                                <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">bool</span>
+                                                                               <a href="#is_valid_version" title="details" class="method-name">is_valid_version</a>
+                                                                                       (<span class="var-type">int</span>&nbsp;<span class="var-name">$photo_idx</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$version_idx</span>)
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">void</span>
+                                                                               <a href="#is_valid_width" title="details" class="method-name">is_valid_width</a>
+                                                                                       (<span class="var-type"></span>&nbsp;<span class="var-name">$image_width</span>)
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        <span class="method-result">string</span>
                                                                                <a href="#parse_uri" title="details" class="method-name">parse_uri</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-type">string</span>&nbsp;<span class="var-name">$txt</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$color</span> = <span class="var-default">000000</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$space</span> = <span class="var-default">4</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$font</span> = <span class="var-default">4</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$w</span> = <span class="var-default">300</span>])
                                                                        </div>
                                                                                                                                <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">string</span>
+                                                                               <a href="#smarty_photo_version_select_list" title="details" class="method-name">smarty_photo_version_select_list</a>
+                                                                                       (<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$smarty</span>, <span class="var-type">smarty</span>&nbsp;<span class="var-name">$smarty</span>)
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        <span class="method-result">string</span>
                                                                                <a href="#smarty_sort_select_list" title="details" class="method-name">smarty_sort_select_list</a>
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$order</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$sort_order</span>)
                                                                        </div>
                                                                                                                                <div class="method-definition">
+                                       <img src="../media/images/Method.png" alt=" "/>
+                                                                                       <span class="method-result">string</span>
+                                                                               <a href="#update_photo_version" title="details" class="method-name">update_photo_version</a>
+                                                                                       (<span class="var-type"></span>&nbsp;<span class="var-name">$photo_idx</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$photo_version</span>)
+                                                                       </div>
+                                                                                                                               <div class="method-definition">
                                        <img src="../media/images/Method.png" alt=" "/>
                                                                                        <span class="method-result">string</span>
                                                                                <a href="#whatToDo" title="details" class="method-name">whatToDo</a>
        
        <div class="method-header">
                <img src="../media/images/Destructor.png" />
-               <span class="method-title">Destructor __destruct</span> (line <span class="line-number">226</span>)
+               <span class="method-title">Destructor __destruct</span> (line <span class="line-number">256</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">762</span>)
+               <span class="method-title">addTag</span> (line <span class="line-number">1031</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">1979</span>)
+               <span class="method-title">checkifImageSupported</span> (line <span class="line-number">2608</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                
                        
        </div>
-<a name="methodcheck_config_table" id="check_config_table"><!-- --></a>
+<a name="methodcheck_phpfspot_db" id="check_phpfspot_db"><!-- --></a>
 <div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">check_config_table</span> (line <span class="line-number">1518</span>)
+               <span class="method-title">check_phpfspot_db</span> (line <span class="line-number">1944</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        <div class="method-signature">
                <span class="method-result">void</span>
                <span class="method-name">
-                       check_config_table
+                       check_phpfspot_db
                </span>
                                ()
                        </div>
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">cleanup_phpfspot_db</span> (line <span class="line-number">2745</span>)
+               <span class="method-title">cleanup_phpfspot_db</span> (line <span class="line-number">3575</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">1351</span>)
+               <span class="method-title">create_thumbnail</span> (line <span class="line-number">1697</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">786</span>)
+               <span class="method-title">delTag</span> (line <span class="line-number">1060</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">1546</span>)
+               <span class="method-title">gen_thumb</span> (line <span class="line-number">2080</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Generates a thumbnail from photo idx</p>
-<p class="description"><p>This function will generate JPEG thumbnails from provided F-Spot photo  indizes.</p><p><ol><li>Check if all thumbnail generations (width) are already in place and
+<p class="short-description">generates thumbnails</p>
+<p class="description"><p>This function generates JPEG thumbnails from  provided F-Spot photo indize and its alternative  versions.</p><p><ol><li>Check if all thumbnail generations (width) are already in place and
     readable</li><li>Check if the md5sum of the original file has changed</li><li>Generate the thumbnails if needed</li></ol></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">getAvailableTags</span> (line <span class="line-number">645</span>)
+               <span class="method-title">getAvailableTags</span> (line <span class="line-number">884</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
                
                        
-       </div>
-<a name="methodgetCurrentPhoto" id="getCurrentPhoto"><!-- --></a>
-<div class="oddrow">
-       
-       <div class="method-header">
-               <img src="../media/images/Method.png" />
-               <span class="method-title">getCurrentPhoto</span> (line <span class="line-number">2256</span>)
-       </div> 
-       
-       <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">return the current photo</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">
-                       getCurrentPhoto
-               </span>
-                               ()
-                       </div>
-       
-               
-                       
        </div>
 <a name="methodgetExport" id="getExport"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getExport</span> (line <span class="line-number">2125</span>)
+               <span class="method-title">getExport</span> (line <span class="line-number">2780</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodgetFspotDBVersion" id="getFspotDBVersion"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getFspotDBVersion</span> (line <span class="line-number">2616</span>)
+               <span class="method-title">getFspotDBVersion</span> (line <span class="line-number">3439</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodgetMD5" id="getMD5"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getMD5</span> (line <span class="line-number">1630</span>)
+               <span class="method-title">getMD5</span> (line <span class="line-number">2191</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
 <p class="short-description">returns stored md5 sum for a specific photo</p>
-<p class="description"><p>this function queries the phpfspot database for a  stored MD5 checksum of the specified photo</p></p>
+<p class="description"><p>this function queries the phpfspot database for a stored MD5  checksum of the specified photo. It also takes care of the  requested photo version - original or alternative photo.</p></p>
        <ul class="tags">
                                <li><span class="field">access:</span> public</li>
                        </ul>
                <span class="method-name">
                        getMD5
                </span>
-                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
+                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$version_idx</span> = <span class="var-default">0</span>])
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">integer</span>
                                <span class="var-name">$idx</span>                      </li>
+                                       <li>
+                               <span class="var-type"></span>
+                               <span class="var-name">$version_idx</span>                      </li>
                                </ul>
                
                        
        </div>
 <a name="methodgetNextSlideShowImage" id="getNextSlideShowImage"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getNextSlideShowImage</span> (line <span class="line-number">2373</span>)
+               <span class="method-title">getNextSlideShowImage</span> (line <span class="line-number">3114</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodgetPhotoName" id="getPhotoName"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getPhotoName</span> (line <span class="line-number">454</span>)
+               <span class="method-title">getPhotoName</span> (line <span class="line-number">594</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>
 <a name="methodgetPhotoSelection" id="getPhotoSelection"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getPhotoSelection</span> (line <span class="line-number">927</span>)
+               <span class="method-title">getPhotoSelection</span> (line <span class="line-number">1217</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodgetPrevSlideShowImage" id="getPrevSlideShowImage"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getPrevSlideShowImage</span> (line <span class="line-number">2393</span>)
+               <span class="method-title">getPrevSlideShowImage</span> (line <span class="line-number">3138</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodgetRSSFeed" id="getRSSFeed"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getRSSFeed</span> (line <span class="line-number">2167</span>)
+               <span class="method-title">getRSSFeed</span> (line <span class="line-number">2827</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodgetSelectedTags" id="getSelectedTags"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getSelectedTags</span> (line <span class="line-number">729</span>)
+               <span class="method-title">getSelectedTags</span> (line <span class="line-number">983</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>
 <a name="methodget_calendar_matrix" id="get_calendar_matrix"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_calendar_matrix</span> (line <span class="line-number">2046</span>)
+               <span class="method-title">get_calendar_matrix</span> (line <span class="line-number">2685</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                <span class="method-name">
                        get_calendar_matrix
                </span>
-                                       ([<span class="var-type">integer</span>&nbsp;<span class="var-name">$year</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$month</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$day</span> = <span class="var-default">0</span>])
+                                       (<span class="var-type"></span>&nbsp;<span class="var-name">$userdate</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$year</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$month</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$day</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">integer</span>
                                <span class="var-name">$day</span>                      </li>
+                                       <li>
+                               <span class="var-type"></span>
+                               <span class="var-name">$userdate</span>                 </li>
                                </ul>
                
                        
        </div>
-<a name="methodget_meta_informations" id="get_meta_informations"><!-- --></a>
+<a name="methodget_current_photo" id="get_current_photo"><!-- --></a>
+<div class="oddrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">get_current_photo</span> (line <span class="line-number">2923</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">return the current photo</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">
+                       get_current_photo
+               </span>
+                               ()
+                       </div>
+       
+               
+                       
+       </div>
+<a name="methodget_current_version" id="get_current_version"><!-- --></a>
 <div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_meta_informations</span> (line <span class="line-number">1505</span>)
+               <span class="method-title">get_current_version</span> (line <span class="line-number">2941</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">return all exif meta data from the file</p>
+<p class="short-description">current selected photo version</p>
+<p class="description"><p>this function returns the current selected photo version  from the session variables.</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-result">int</span>
                <span class="method-name">
-                       get_meta_informations
+                       get_current_version
                </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>
+<a name="methodget_db_version" id="get_db_version"><!-- --></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">2545</span>)
+               <span class="method-title">get_db_version</span> (line <span class="line-number">3770</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">returns the number of photos which are tagged with $tag_id</p>
+<p class="short-description">get database version</p>
+<p class="description"><p>this function queries the meta table  and returns the current database version.</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_num_photos
+                       get_db_version
                </span>
-                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$tag_id</span>)
+                               ()
                        </div>
        
-                       <ul class="parameters">
-                                       <li>
-                               <span class="var-type">integer</span>
-                               <span class="var-name">$tag_id</span>                   </li>
-                               </ul>
                
                        
        </div>
-<a name="methodget_photo_details" id="get_photo_details"><!-- --></a>
+<a name="methodget_latest_version" id="get_latest_version"><!-- --></a>
 <div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_photo_details</span> (line <span class="line-number">395</span>)
+               <span class="method-title">get_latest_version</span> (line <span class="line-number">2959</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">extract all photo details</p>
-<p class="description"><p>retrieve all available details from f-spot's  database and return them as object</p></p>
+<p class="short-description">returns latest available photo version</p>
+<p class="description"><p>this function returns the latested available version  for the requested photo.</p></p>
        <ul class="tags">
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
-               <span class="method-result">object|null</span>
+               <span class="method-result">int</span>
                <span class="method-name">
-                       get_photo_details
+                       get_latest_version
                </span>
-                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
+                                       (<span class="var-type"></span>&nbsp;<span class="var-name">$photo_idx</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
-                               <span class="var-type">integer</span>
-                               <span class="var-name">$idx</span>                      </li>
+                               <span class="var-type"></span>
+                               <span class="var-name">$photo_idx</span>                        </li>
                                </ul>
                
                        
        </div>
-<a name="methodget_random_photo" id="get_random_photo"><!-- --></a>
+<a name="methodget_meta_informations" id="get_meta_informations"><!-- --></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">2424</span>)
+               <span class="method-title">get_meta_informations</span> (line <span class="line-number">1931</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">get random photo</p>
-<p class="description"><p>this function will get all photos 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>
+<p class="short-description">return all exif meta data from the file</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_photo
+                       get_meta_informations
                </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_thumb_path" id="get_thumb_path"><!-- --></a>
+<a name="methodget_mime_info" id="get_mime_info"><!-- --></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">2496</span>)
+               <span class="method-title">get_mime_info</span> (line <span class="line-number">3636</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">returns the full path to a thumbnail</p>
+<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_thumb_path
+                       get_mime_info
                </span>
-                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$width</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$photo</span>)
+                                       (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
-                               <span class="var-type">integer</span>
-                               <span class="var-name">$width</span>                    </li>
-                                       <li>
-                               <span class="var-type">integer</span>
-                               <span class="var-name">$photo</span>                    </li>
+                               <span class="var-type">string</span>
+                               <span class="var-name">$file</span>                     </li>
                                </ul>
                
                        
        </div>
-<a name="methodget_xml_tag_list" id="get_xml_tag_list"><!-- --></a>
+<a name="methodget_num_photos" id="get_num_photos"><!-- --></a>
 <div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_xml_tag_list</span> (line <span class="line-number">818</span>)
+               <span class="method-title">get_num_photos</span> (line <span class="line-number">3368</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 number of photos which are tagged with $tag_id</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-result">integer</span>
                <span class="method-name">
-                       get_xml_tag_list
+                       get_num_photos
                </span>
-                               ()
+                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$tag_id</span>)
                        </div>
        
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type">integer</span>
+                               <span class="var-name">$tag_id</span>                   </li>
+                               </ul>
                
                        
        </div>
-<a name="methodisValidDate" id="isValidDate"><!-- --></a>
+<a name="methodget_photo_details" id="get_photo_details"><!-- --></a>
 <div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">isValidDate</span> (line <span class="line-number">2450</span>)
+               <span class="method-title">get_photo_details</span> (line <span class="line-number">480</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">validates provided date</p>
-<p class="description"><p>this function validates if the provided date  contains a valid date and will return true  if it is.</p></p>
+<p class="short-description">get all photo details from F-Spot database</p>
+<p class="description"><p>this function queries the F-Spot database for all available  details of the requested photo. It returns them as a object.</p><p>Furthermore it takes care of the photo version to be requested.  If photo version is not yet, it queries information for the  original photo.</p></p>
        <ul class="tags">
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
-               <span class="method-result">boolean</span>
+               <span class="method-result">object|null</span>
                <span class="method-name">
-                       isValidDate
+                       get_photo_details
                </span>
-                                       (<span class="var-type">string</span>&nbsp;<span class="var-name">$date_str</span>)
+                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$version_idx</span> = <span class="var-default">NULL</span>])
                        </div>
        
                        <ul class="parameters">
                                        <li>
-                               <span class="var-type">string</span>
-                               <span class="var-name">$date_str</span>                 </li>
+                               <span class="var-type">integer</span>
+                               <span class="var-name">$idx</span>                      </li>
+                                       <li>
+                               <span class="var-type"></span>
+                               <span class="var-name">$version_idx</span>                      </li>
                                </ul>
                
                        
        </div>
-<a name="methodparse_uri" id="parse_uri"><!-- --></a>
+<a name="methodget_photo_rating" id="get_photo_rating"><!-- --></a>
 <div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">parse_uri</span> (line <span class="line-number">2636</span>)
+               <span class="method-title">get_photo_rating</span> (line <span class="line-number">618</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">parse the provided URI and will returned the requested chunk</p>
+<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">string</span>
+               <span class="method-result">integer</span>
                <span class="method-name">
-                       parse_uri
+                       get_photo_rating
                </span>
-                                       (<span class="var-type">string</span>&nbsp;<span class="var-name">$uri</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$mode</span>)
+                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
-                               <span class="var-type">string</span>
-                               <span class="var-name">$uri</span>                      </li>
-                                       <li>
-                               <span class="var-type">string</span>
-                               <span class="var-name">$mode</span>                     </li>
+                               <span class="var-type">integer</span>
+                               <span class="var-name">$idx</span><span class="var-description">: idx</span>                    </li>
                                </ul>
                
                        
        </div>
-<a name="methodresetDateSearch" id="resetDateSearch"><!-- --></a>
+<a name="methodget_photo_versions" id="get_photo_versions"><!-- --></a>
 <div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetDateSearch</span> (line <span class="line-number">909</span>)
+               <span class="method-title">get_photo_versions</span> (line <span class="line-number">3798</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="short-description">get photo versions</p>
+<p class="description"><p>this function returns an array of all available  alterntaive versions of the provided photo id.  has alternative photo versions available</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-result">array</span>
                <span class="method-name">
-                       resetDateSearch
+                       get_photo_versions
                </span>
-                               ()
+                                       (<span class="var-type">int</span>&nbsp;<span class="var-name">$idx</span>)
                        </div>
        
-               
-                       
-       </div>
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type">int</span>
+                               <span class="var-name">$idx</span>                      </li>
+                               </ul>
+               
+                       
+       </div>
+<a name="methodget_photo_version_name" id="get_photo_version_name"><!-- --></a>
+<div class="oddrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">get_photo_version_name</span> (line <span class="line-number">3852</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">get photo version name</p>
+<p class="description"><p>this function returns the name of the version  identified by the photo-id and version-id.</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_photo_version_name
+               </span>
+                                       (<span class="var-type">int</span>&nbsp;<span class="var-name">$photo_idx</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$version_idx</span>)
+                       </div>
+       
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type">int</span>
+                               <span class="var-name">$photo_idx</span>                        </li>
+                                       <li>
+                               <span class="var-type">int</span>
+                               <span class="var-name">$version_idx</span>                      </li>
+                               </ul>
+               
+                       
+       </div>
+<a name="methodget_random_photo" id="get_random_photo"><!-- --></a>
+<div class="evenrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">get_random_photo</span> (line <span class="line-number">3173</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">get random photo</p>
+<p class="description"><p>this function will get all photos 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_photo
+               </span>
+                               ()
+                       </div>
+       
+               
+                       
+       </div>
+<a name="methodget_random_tag_photo" id="get_random_tag_photo"><!-- --></a>
+<div class="oddrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">get_random_tag_photo</span> (line <span class="line-number">3216</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="evenrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">get_rate_search</span> (line <span class="line-number">636</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="oddrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">get_tag_name</span> (line <span class="line-number">3663</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="evenrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">get_thumb_path</span> (line <span class="line-number">3318</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">returns the full path to a thumbnail</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_thumb_path
+               </span>
+                                       (<span class="var-type">integer</span>&nbsp;<span class="var-name">$width</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$photo_idx</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$version_idx</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$photo</span>)
+                       </div>
+       
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type">integer</span>
+                               <span class="var-name">$width</span>                    </li>
+                                       <li>
+                               <span class="var-type">integer</span>
+                               <span class="var-name">$photo</span>                    </li>
+                                       <li>
+                               <span class="var-type"></span>
+                               <span class="var-name">$photo_idx</span>                        </li>
+                                       <li>
+                               <span class="var-type"></span>
+                               <span class="var-name">$version_idx</span>                      </li>
+                               </ul>
+               
+                       
+       </div>
+<a name="methodget_xml_tag_list" id="get_xml_tag_list"><!-- --></a>
+<div class="oddrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">get_xml_tag_list</span> (line <span class="line-number">1092</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<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 class="method-signature">
+               <span class="method-result">string</span>
+               <span class="method-name">
+                       get_xml_tag_list
+               </span>
+                               ()
+                       </div>
+       
+               
+                       
+       </div>
+<a name="methodisValidDate" id="isValidDate"><!-- --></a>
+<div class="evenrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">isValidDate</span> (line <span class="line-number">3270</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">validates provided date</p>
+<p class="description"><p>this function validates if the provided date  contains a valid date and will return true  if it is.</p></p>
+       <ul class="tags">
+                               <li><span class="field">access:</span> public</li>
+                       </ul>
+       
+       <div class="method-signature">
+               <span class="method-result">boolean</span>
+               <span class="method-name">
+                       isValidDate
+               </span>
+                                       (<span class="var-type">string</span>&nbsp;<span class="var-name">$date_str</span>)
+                       </div>
+       
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type">string</span>
+                               <span class="var-name">$date_str</span>                 </li>
+                               </ul>
+               
+                       
+       </div>
+<a name="methodis_valid_version" id="is_valid_version"><!-- --></a>
+<div class="oddrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">is_valid_version</span> (line <span class="line-number">3827</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">check for invalid version of photo</p>
+<p class="description"><p>this function validates the provided photo-id and version-id</p></p>
+       <ul class="tags">
+                               <li><span class="field">access:</span> public</li>
+                       </ul>
+       
+       <div class="method-signature">
+               <span class="method-result">bool</span>
+               <span class="method-name">
+                       is_valid_version
+               </span>
+                                       (<span class="var-type">int</span>&nbsp;<span class="var-name">$photo_idx</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$version_idx</span>)
+                       </div>
+       
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type">int</span>
+                               <span class="var-name">$photo_idx</span>                        </li>
+                                       <li>
+                               <span class="var-type">int</span>
+                               <span class="var-name">$version_idx</span>                      </li>
+                               </ul>
+               
+                       
+       </div>
+<a name="methodis_valid_width" id="is_valid_width"><!-- --></a>
+<div class="evenrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">is_valid_width</span> (line <span class="line-number">3874</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+       <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">
+                       is_valid_width
+               </span>
+                                       (<span class="var-type"></span>&nbsp;<span class="var-name">$image_width</span>)
+                       </div>
+       
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type"></span>
+                               <span class="var-name">$image_width</span>                      </li>
+                               </ul>
+               
+                       
+       </div>
+<a name="methodparse_uri" id="parse_uri"><!-- --></a>
+<div class="oddrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">parse_uri</span> (line <span class="line-number">3459</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">parse the provided URI and will returned the requested chunk</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">
+                       parse_uri
+               </span>
+                                       (<span class="var-type">string</span>&nbsp;<span class="var-name">$uri</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$mode</span>)
+                       </div>
+       
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type">string</span>
+                               <span class="var-name">$uri</span>                      </li>
+                                       <li>
+                               <span class="var-type">string</span>
+                               <span class="var-name">$mode</span>                     </li>
+                               </ul>
+               
+                       
+       </div>
+<a name="methodresetDateSearch" id="resetDateSearch"><!-- --></a>
+<div class="evenrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">resetDateSearch</span> (line <span class="line-number">1185</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>
+       <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">
+                       resetDateSearch
+               </span>
+                               ()
+                       </div>
+       
+               
+                       
+       </div>
 <a name="methodresetNameSearch" id="resetNameSearch"><!-- --></a>
 <div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetNameSearch</span> (line <span class="line-number">896</span>)
+               <span class="method-title">resetNameSearch</span> (line <span class="line-number">1173</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetPhotoView</span> (line <span class="line-number">872</span>)
+               <span class="method-title">resetPhotoView</span> (line <span class="line-number">1146</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                
                        
        </div>
-<a name="methodresetSlideShow" id="resetSlideShow"><!-- --></a>
+<a name="methodresetRateSearch" id="resetRateSearch"><!-- --></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">2406</span>)
+               <span class="method-title">resetRateSearch</span> (line <span class="line-number">1199</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="evenrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">resetSlideShow</span> (line <span class="line-number">3155</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodresetTags" id="resetTags"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetTags</span> (line <span class="line-number">807</span>)
+               <span class="method-title">resetTags</span> (line <span class="line-number">1081</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodresetTagSearch" id="resetTagSearch"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetTagSearch</span> (line <span class="line-number">884</span>)
+               <span class="method-title">resetTagSearch</span> (line <span class="line-number">1161</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodsetTagCondition" id="setTagCondition"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">setTagCondition</span> (line <span class="line-number">1668</span>)
+               <span class="method-title">setTagCondition</span> (line <span class="line-number">2241</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodshow" id="show"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">show</span> (line <span class="line-number">240</span>)
+               <span class="method-title">show</span> (line <span class="line-number">270</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodshowCredits" id="showCredits"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">showCredits</span> (line <span class="line-number">1330</span>)
+               <span class="method-title">showCredits</span> (line <span class="line-number">1676</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodshowPhoto" id="showPhoto"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">showPhoto</span> (line <span class="line-number">509</span>)
+               <span class="method-title">showPhoto</span> (line <span class="line-number">723</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="methodshowPhotoIndex" id="showPhotoIndex"><!-- --></a>
-<div class="evenrow">
+<div class="oddrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">showPhotoIndex</span> (line <span class="line-number">1131</span>)
+               <span class="method-title">showPhotoIndex</span> (line <span class="line-number">1454</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>
 <a name="methodshowTextImage" id="showTextImage"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">showTextImage</span> (line <span class="line-number">1893</span>)
+               <span class="method-title">showTextImage</span> (line <span class="line-number">2510</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                                </ul>
                
                        
+       </div>
+<a name="methodsmarty_photo_version_select_list" id="smarty_photo_version_select_list"><!-- --></a>
+<div class="oddrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">smarty_photo_version_select_list</span> (line <span class="line-number">3019</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">photo version select list</p>
+<p class="description"><p>this function returns a HTML select list (drop down)  to select a alternative photo version of the original photo.</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">
+                       smarty_photo_version_select_list
+               </span>
+                                       (<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$smarty</span>, <span class="var-type">smarty</span>&nbsp;<span class="var-name">$smarty</span>)
+                       </div>
+       
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type">array</span>
+                               <span class="var-name">$params</span>                   </li>
+                                       <li>
+                               <span class="var-type">smarty</span>
+                               <span class="var-name">$smarty</span>                   </li>
+                                       <li>
+                               <span class="var-type"></span>
+                               <span class="var-name">&$smarty</span>                  </li>
+                               </ul>
+               
+                       
        </div>
 <a name="methodsmarty_sort_select_list" id="smarty_sort_select_list"><!-- --></a>
 <div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">smarty_sort_select_list</span> (line <span class="line-number">2311</span>)
+               <span class="method-title">smarty_sort_select_list</span> (line <span class="line-number">3046</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">1686</span>)
+               <span class="method-title">startSearch</span> (line <span class="line-number">2259</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">496</span>)
+               <span class="method-title">translate_path</span> (line <span class="line-number">705</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">1738</span>)
+               <span class="method-title">updateSortOrder</span> (line <span class="line-number">2333</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                
                        
        </div>
-<a name="methodwhatToDo" id="whatToDo"><!-- --></a>
+<a name="methodupdate_photo_version" id="update_photo_version"><!-- --></a>
 <div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">whatToDo</span> (line <span class="line-number">2273</span>)
+               <span class="method-title">update_photo_version</span> (line <span class="line-number">2352</span>)
+       </div> 
+       
+       <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">update photo version in session variable</p>
+<p class="description"><p>this function is invoked by RPC and will set the requested  photo version in the session variable.</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">
+                       update_photo_version
+               </span>
+                                       (<span class="var-type"></span>&nbsp;<span class="var-name">$photo_idx</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$photo_version</span>)
+                       </div>
+       
+                       <ul class="parameters">
+                                       <li>
+                               <span class="var-type">string</span>
+                               <span class="var-name">$photo_version</span>                    </li>
+                                       <li>
+                               <span class="var-type"></span>
+                               <span class="var-name">$photo_idx</span>                        </li>
+                               </ul>
+               
+                       
+       </div>
+<a name="methodwhatToDo" id="whatToDo"><!-- --></a>
+<div class="oddrow">
+       
+       <div class="method-header">
+               <img src="../media/images/Method.png" />
+               <span class="method-title">whatToDo</span> (line <span class="line-number">2980</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
                        
        </div>
 <a name="method_error" id="_error"><!-- --></a>
-<div class="oddrow">
+<div class="evenrow">
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">_error</span> (line <span class="line-number">1992</span>)
+               <span class="method-title">_error</span> (line <span class="line-number">2628</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
 
        
        <p class="notes" id="credit">
-               Documentation generated on Sat, 12 Apr 2008 18:39:42 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+               Documentation generated on Sat, 30 May 2009 10:14:35 +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