update docs and UPGRADE file to 1.6
[phpfspot.git] / docs / phpfspot / PHPFSPOT.html
index 6b31c6b739f62bdd6c712aee8d1c42165b17a4e0..de4a0f25656c46c2cc77cce443d2029a7f9320d8 100644 (file)
        
        <div class="method-header">
                <img src="../media/images/Destructor.png" />
-               <span class="method-title">Destructor __destruct</span> (line <span class="line-number">243</span>)
+               <span class="method-title">Destructor __destruct</span> (line <span class="line-number">248</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">addTag</span> (line <span class="line-number">925</span>)
+               <span class="method-title">addTag</span> (line <span class="line-number">953</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">checkifImageSupported</span> (line <span class="line-number">2322</span>)
+               <span class="method-title">checkifImageSupported</span> (line <span class="line-number">2350</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">check_config_table</span> (line <span class="line-number">1818</span>)
+               <span class="method-title">check_config_table</span> (line <span class="line-number">1846</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">cleanup_phpfspot_db</span> (line <span class="line-number">3190</span>)
+               <span class="method-title">cleanup_phpfspot_db</span> (line <span class="line-number">3215</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">create_thumbnail</span> (line <span class="line-number">1571</span>)
+               <span class="method-title">create_thumbnail</span> (line <span class="line-number">1599</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">delTag</span> (line <span class="line-number">954</span>)
+               <span class="method-title">delTag</span> (line <span class="line-number">982</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">gen_thumb</span> (line <span class="line-number">1846</span>)
+               <span class="method-title">gen_thumb</span> (line <span class="line-number">1874</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getAvailableTags</span> (line <span class="line-number">791</span>)
+               <span class="method-title">getAvailableTags</span> (line <span class="line-number">806</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getCurrentPhoto</span> (line <span class="line-number">2620</span>)
+               <span class="method-title">getCurrentPhoto</span> (line <span class="line-number">2645</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getExport</span> (line <span class="line-number">2475</span>)
+               <span class="method-title">getExport</span> (line <span class="line-number">2502</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getFspotDBVersion</span> (line <span class="line-number">3059</span>)
+               <span class="method-title">getFspotDBVersion</span> (line <span class="line-number">3084</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getMD5</span> (line <span class="line-number">1948</span>)
+               <span class="method-title">getMD5</span> (line <span class="line-number">1976</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getNextSlideShowImage</span> (line <span class="line-number">2740</span>)
+               <span class="method-title">getNextSlideShowImage</span> (line <span class="line-number">2765</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getPhotoName</span> (line <span class="line-number">522</span>)
+               <span class="method-title">getPhotoName</span> (line <span class="line-number">538</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
 <p class="short-description">returns aligned photo names</p>
-<p class="description"><p>this function returns aligned (length) names for  an specific photo. If the length of the name exceeds  $limit the name will be shrinked (...)</p></p>
+<p class="description"><p>this function returns aligned (length) names for a specific photo.  If the length of the name exceeds $limit the name will bei  shrinked (...).</p></p>
        <ul class="tags">
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getPhotoSelection</span> (line <span class="line-number">1108</span>)
+               <span class="method-title">getPhotoSelection</span> (line <span class="line-number">1136</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getPrevSlideShowImage</span> (line <span class="line-number">2764</span>)
+               <span class="method-title">getPrevSlideShowImage</span> (line <span class="line-number">2789</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getRSSFeed</span> (line <span class="line-number">2522</span>)
+               <span class="method-title">getRSSFeed</span> (line <span class="line-number">2549</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">getSelectedTags</span> (line <span class="line-number">877</span>)
+               <span class="method-title">getSelectedTags</span> (line <span class="line-number">905</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_calendar_matrix</span> (line <span class="line-number">2396</span>)
+               <span class="method-title">get_calendar_matrix</span> (line <span class="line-number">2423</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_meta_informations</span> (line <span class="line-number">1805</span>)
+               <span class="method-title">get_meta_informations</span> (line <span class="line-number">1833</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_mime_info</span> (line <span class="line-number">3251</span>)
+               <span class="method-title">get_mime_info</span> (line <span class="line-number">3276</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_num_photos</span> (line <span class="line-number">2988</span>)
+               <span class="method-title">get_num_photos</span> (line <span class="line-number">3013</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_photo_details</span> (line <span class="line-number">454</span>)
+               <span class="method-title">get_photo_details</span> (line <span class="line-number">465</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_photo_rating</span> (line <span class="line-number">546</span>)
+               <span class="method-title">get_photo_rating</span> (line <span class="line-number">562</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
 <p class="short-description">get photo rating level</p>
-<p class="description"><p>this function will return the integer-based rating  level of the photo. This can only be done, if the F-Spot  database is at a specific level. If rating value can not  be found, zero will be returned indicating no rating value  is available.</p></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-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_random_photo</span> (line <span class="line-number">2799</span>)
+               <span class="method-title">get_random_photo</span> (line <span class="line-number">2824</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_random_tag_photo</span> (line <span class="line-number">2842</span>)
+               <span class="method-title">get_random_tag_photo</span> (line <span class="line-number">2867</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_rate_search</span> (line <span class="line-number">564</span>)
+               <span class="method-title">get_rate_search</span> (line <span class="line-number">580</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
 <p class="short-description">get rate-search bars</p>
-<p class="description"><p>this function will return the rating-bars for the  search field.</p></p>
+<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-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_tag_name</span> (line <span class="line-number">3278</span>)
+               <span class="method-title">get_tag_name</span> (line <span class="line-number">3303</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_thumb_path</span> (line <span class="line-number">2938</span>)
+               <span class="method-title">get_thumb_path</span> (line <span class="line-number">2963</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">get_xml_tag_list</span> (line <span class="line-number">986</span>)
+               <span class="method-title">get_xml_tag_list</span> (line <span class="line-number">1014</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">isValidDate</span> (line <span class="line-number">2890</span>)
+               <span class="method-title">isValidDate</span> (line <span class="line-number">2915</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">parse_uri</span> (line <span class="line-number">3079</span>)
+               <span class="method-title">parse_uri</span> (line <span class="line-number">3104</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetDateSearch</span> (line <span class="line-number">1076</span>)
+               <span class="method-title">resetDateSearch</span> (line <span class="line-number">1104</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetNameSearch</span> (line <span class="line-number">1064</span>)
+               <span class="method-title">resetNameSearch</span> (line <span class="line-number">1092</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">1040</span>)
+               <span class="method-title">resetPhotoView</span> (line <span class="line-number">1068</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetRateSearch</span> (line <span class="line-number">1090</span>)
+               <span class="method-title">resetRateSearch</span> (line <span class="line-number">1118</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetSlideShow</span> (line <span class="line-number">2781</span>)
+               <span class="method-title">resetSlideShow</span> (line <span class="line-number">2806</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetTags</span> (line <span class="line-number">975</span>)
+               <span class="method-title">resetTags</span> (line <span class="line-number">1003</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">resetTagSearch</span> (line <span class="line-number">1052</span>)
+               <span class="method-title">resetTagSearch</span> (line <span class="line-number">1080</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">setTagCondition</span> (line <span class="line-number">1986</span>)
+               <span class="method-title">setTagCondition</span> (line <span class="line-number">2014</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">show</span> (line <span class="line-number">257</span>)
+               <span class="method-title">show</span> (line <span class="line-number">262</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">showCredits</span> (line <span class="line-number">1550</span>)
+               <span class="method-title">showCredits</span> (line <span class="line-number">1578</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">showPhoto</span> (line <span class="line-number">646</span>)
+               <span class="method-title">showPhoto</span> (line <span class="line-number">662</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">showPhotoIndex</span> (line <span class="line-number">1337</span>)
+               <span class="method-title">showPhotoIndex</span> (line <span class="line-number">1365</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">showTextImage</span> (line <span class="line-number">2236</span>)
+               <span class="method-title">showTextImage</span> (line <span class="line-number">2264</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">smarty_sort_select_list</span> (line <span class="line-number">2672</span>)
+               <span class="method-title">smarty_sort_select_list</span> (line <span class="line-number">2697</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">startSearch</span> (line <span class="line-number">2004</span>)
+               <span class="method-title">startSearch</span> (line <span class="line-number">2032</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">translate_path</span> (line <span class="line-number">633</span>)
+               <span class="method-title">translate_path</span> (line <span class="line-number">649</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">updateSortOrder</span> (line <span class="line-number">2078</span>)
+               <span class="method-title">updateSortOrder</span> (line <span class="line-number">2106</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">whatToDo</span> (line <span class="line-number">2637</span>)
+               <span class="method-title">whatToDo</span> (line <span class="line-number">2662</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        
        <div class="method-header">
                <img src="../media/images/Method.png" />
-               <span class="method-title">_error</span> (line <span class="line-number">2342</span>)
+               <span class="method-title">_error</span> (line <span class="line-number">2370</span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
 
        
        <p class="notes" id="credit">
-               Documentation generated on Sun, 25 May 2008 10:46:25 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+               Documentation generated on Wed, 02 Jul 2008 20:40:55 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
        </p>
        </div></body>
 </html>
\ No newline at end of file