diff options
Diffstat (limited to 'docs/phpfspot/PHPFSPOT.html')
| -rw-r--r-- | docs/phpfspot/PHPFSPOT.html | 627 |
1 files changed, 489 insertions, 138 deletions
diff --git a/docs/phpfspot/PHPFSPOT.html b/docs/phpfspot/PHPFSPOT.html index de4a0f2..5131ab2 100644 --- a/docs/phpfspot/PHPFSPOT.html +++ b/docs/phpfspot/PHPFSPOT.html @@ -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> @@ -124,7 +124,7 @@ <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"> @@ -160,12 +160,6 @@ <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> (<span class="var-type">string</span> <span class="var-name">$mode</span>) </div> @@ -179,7 +173,7 @@ <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> <span class="var-name">$idx</span>) + (<span class="var-type">integer</span> <span class="var-name">$idx</span>, [<span class="var-type"></span> <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=" "/> @@ -221,7 +215,31 @@ <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> <span class="var-name">$year</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span> <span class="var-name">$month</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span> <span class="var-name">$day</span> = <span class="var-default">0</span>]) + (<span class="var-type"></span> <span class="var-name">$userdate</span>, <span class="var-type">integer</span> <span class="var-name">$year</span>, <span class="var-type">integer</span> <span class="var-name">$month</span>, <span class="var-type">integer</span> <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> <span class="var-name">$photo_idx</span>) </div> <div class="method-definition"> <img src="../media/images/Method.png" alt=" "/> @@ -245,7 +263,7 @@ <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> <span class="var-name">$idx</span>) + (<span class="var-type">integer</span> <span class="var-name">$idx</span>, [<span class="var-type"></span> <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=" "/> @@ -256,6 +274,18 @@ <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> <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> <span class="var-name">$photo_idx</span>, <span class="var-type">int</span> <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> @@ -281,7 +311,7 @@ <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> <span class="var-name">$width</span>, <span class="var-type">integer</span> <span class="var-name">$photo</span>) + (<span class="var-type">integer</span> <span class="var-name">$width</span>, <span class="var-type"></span> <span class="var-name">$photo_idx</span>, <span class="var-type"></span> <span class="var-name">$version_idx</span>, <span class="var-type">integer</span> <span class="var-name">$photo</span>) </div> <div class="method-definition"> <img src="../media/images/Method.png" alt=" "/> @@ -297,6 +327,18 @@ </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> <span class="var-name">$photo_idx</span>, <span class="var-type">int</span> <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> <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> (<span class="var-type">string</span> <span class="var-name">$uri</span>, <span class="var-type">string</span> <span class="var-name">$mode</span>) @@ -382,6 +424,12 @@ <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> <span class="var-name">$params</span>, <span class="var-type"></span> <span class="var-name">&$smarty</span>, <span class="var-type">smarty</span> <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">array</span> <span class="var-name">$params</span>, <span class="var-type"></span> <span class="var-name">&$smarty</span>, <span class="var-type">smarty</span> <span class="var-name">$smarty</span>) </div> @@ -406,6 +454,12 @@ <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> <span class="var-name">$photo_idx</span>, <span class="var-type">string</span> <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> @@ -622,7 +676,7 @@ <div class="method-header"> <img src="../media/images/Destructor.png" /> - <span class="method-title">Destructor __destruct</span> (line <span class="line-number">248</span>) + <span class="method-title">Destructor __destruct</span> (line <span class="line-number">256</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -646,7 +700,7 @@ <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">addTag</span> (line <span class="line-number">953</span>) + <span class="method-title">addTag</span> (line <span class="line-number">1031</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -677,7 +731,7 @@ <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">checkifImageSupported</span> (line <span class="line-number">2350</span>) + <span class="method-title">checkifImageSupported</span> (line <span class="line-number">2608</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -702,12 +756,12 @@ </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">1846</span>) + <span class="method-title">check_phpfspot_db</span> (line <span class="line-number">1944</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -720,7 +774,7 @@ <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> - check_config_table + check_phpfspot_db </span> () </div> @@ -733,7 +787,7 @@ <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">cleanup_phpfspot_db</span> (line <span class="line-number">3215</span>) + <span class="method-title">cleanup_phpfspot_db</span> (line <span class="line-number">3575</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -759,7 +813,7 @@ <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">create_thumbnail</span> (line <span class="line-number">1599</span>) + <span class="method-title">create_thumbnail</span> (line <span class="line-number">1697</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -796,7 +850,7 @@ <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">delTag</span> (line <span class="line-number">982</span>) + <span class="method-title">delTag</span> (line <span class="line-number">1060</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -827,12 +881,12 @@ <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">gen_thumb</span> (line <span class="line-number">1874</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> @@ -865,7 +919,7 @@ <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">getAvailableTags</span> (line <span class="line-number">806</span>) + <span class="method-title">getAvailableTags</span> (line <span class="line-number">884</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -886,37 +940,12 @@ </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">2645</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">2502</span>) + <span class="method-title">getExport</span> (line <span class="line-number">2780</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -942,11 +971,11 @@ </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">3084</span>) + <span class="method-title">getFspotDBVersion</span> (line <span class="line-number">3439</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -968,16 +997,16 @@ </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">1976</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> @@ -987,23 +1016,26 @@ <span class="method-name"> getMD5 </span> - (<span class="var-type">integer</span> <span class="var-name">$idx</span>) + (<span class="var-type">integer</span> <span class="var-name">$idx</span>, [<span class="var-type"></span> <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">2765</span>) + <span class="method-title">getNextSlideShowImage</span> (line <span class="line-number">3114</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1025,11 +1057,11 @@ </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">538</span>) + <span class="method-title">getPhotoName</span> (line <span class="line-number">594</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1059,11 +1091,11 @@ </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">1136</span>) + <span class="method-title">getPhotoSelection</span> (line <span class="line-number">1217</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1085,11 +1117,11 @@ </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">2789</span>) + <span class="method-title">getPrevSlideShowImage</span> (line <span class="line-number">3138</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1111,11 +1143,11 @@ </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">2549</span>) + <span class="method-title">getRSSFeed</span> (line <span class="line-number">2827</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1136,11 +1168,11 @@ </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">905</span>) + <span class="method-title">getSelectedTags</span> (line <span class="line-number">983</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1167,11 +1199,11 @@ </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">2423</span>) + <span class="method-title">get_calendar_matrix</span> (line <span class="line-number">2685</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1185,7 +1217,7 @@ <span class="method-name"> get_calendar_matrix </span> - ([<span class="var-type">integer</span> <span class="var-name">$year</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span> <span class="var-name">$month</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span> <span class="var-name">$day</span> = <span class="var-default">0</span>]) + (<span class="var-type"></span> <span class="var-name">$userdate</span>, <span class="var-type">integer</span> <span class="var-name">$year</span>, <span class="var-type">integer</span> <span class="var-name">$month</span>, <span class="var-type">integer</span> <span class="var-name">$day</span>) </div> <ul class="parameters"> @@ -1198,16 +1230,127 @@ <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">1833</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">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">int</span> + <span class="method-name"> + get_current_version + </span> + () + </div> + + + + </div> +<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_db_version</span> (line <span class="line-number">3770</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<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_db_version + </span> + () + </div> + + + + </div> +<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_latest_version</span> (line <span class="line-number">2959</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<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">int</span> + <span class="method-name"> + get_latest_version + </span> + (<span class="var-type"></span> <span class="var-name">$photo_idx</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type"></span> + <span class="var-name">$photo_idx</span> </li> + </ul> + + + </div> +<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_meta_informations</span> (line <span class="line-number">1931</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1233,11 +1376,11 @@ </div> <a name="methodget_mime_info" id="get_mime_info"><!-- --></a> -<div class="oddrow"> +<div class="evenrow"> <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">get_mime_info</span> (line <span class="line-number">3276</span>) + <span class="method-title">get_mime_info</span> (line <span class="line-number">3636</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1264,11 +1407,11 @@ </div> <a name="methodget_num_photos" id="get_num_photos"><!-- --></a> -<div class="evenrow"> +<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">3013</span>) + <span class="method-title">get_num_photos</span> (line <span class="line-number">3368</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1294,16 +1437,16 @@ </div> <a name="methodget_photo_details" id="get_photo_details"><!-- --></a> -<div class="oddrow"> +<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">465</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">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">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> @@ -1313,23 +1456,26 @@ <span class="method-name"> get_photo_details </span> - (<span class="var-type">integer</span> <span class="var-name">$idx</span>) + (<span class="var-type">integer</span> <span class="var-name">$idx</span>, [<span class="var-type"></span> <span class="var-name">$version_idx</span> = <span class="var-default">NULL</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="methodget_photo_rating" id="get_photo_rating"><!-- --></a> -<div class="evenrow"> +<div class="oddrow"> <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">get_photo_rating</span> (line <span class="line-number">562</span>) + <span class="method-title">get_photo_rating</span> (line <span class="line-number">618</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1355,12 +1501,77 @@ </div> -<a name="methodget_random_photo" id="get_random_photo"><!-- --></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">get_photo_versions</span> (line <span class="line-number">3798</span>) + </div> + + <!-- ========== Info from phpDoc block ========= --> +<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">array</span> + <span class="method-name"> + get_photo_versions + </span> + (<span class="var-type">int</span> <span class="var-name">$idx</span>) + </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_random_photo</span> (line <span class="line-number">2824</span>) + <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> <span class="var-name">$photo_idx</span>, <span class="var-type">int</span> <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 ========= --> @@ -1382,11 +1593,11 @@ </div> <a name="methodget_random_tag_photo" id="get_random_tag_photo"><!-- --></a> -<div class="evenrow"> +<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">2867</span>) + <span class="method-title">get_random_tag_photo</span> (line <span class="line-number">3216</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1413,11 +1624,11 @@ </div> <a name="methodget_rate_search" id="get_rate_search"><!-- --></a> -<div class="oddrow"> +<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">580</span>) + <span class="method-title">get_rate_search</span> (line <span class="line-number">636</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1439,11 +1650,11 @@ </div> <a name="methodget_tag_name" id="get_tag_name"><!-- --></a> -<div class="evenrow"> +<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">3303</span>) + <span class="method-title">get_tag_name</span> (line <span class="line-number">3663</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1470,11 +1681,11 @@ </div> <a name="methodget_thumb_path" id="get_thumb_path"><!-- --></a> -<div class="oddrow"> +<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">2963</span>) + <span class="method-title">get_thumb_path</span> (line <span class="line-number">3318</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1488,7 +1699,7 @@ <span class="method-name"> get_thumb_path </span> - (<span class="var-type">integer</span> <span class="var-name">$width</span>, <span class="var-type">integer</span> <span class="var-name">$photo</span>) + (<span class="var-type">integer</span> <span class="var-name">$width</span>, <span class="var-type"></span> <span class="var-name">$photo_idx</span>, <span class="var-type"></span> <span class="var-name">$version_idx</span>, <span class="var-type">integer</span> <span class="var-name">$photo</span>) </div> <ul class="parameters"> @@ -1498,16 +1709,22 @@ <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="evenrow"> +<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">1014</span>) + <span class="method-title">get_xml_tag_list</span> (line <span class="line-number">1092</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1528,11 +1745,11 @@ </div> <a name="methodisValidDate" id="isValidDate"><!-- --></a> -<div class="oddrow"> +<div class="evenrow"> <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">isValidDate</span> (line <span class="line-number">2915</span>) + <span class="method-title">isValidDate</span> (line <span class="line-number">3270</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1558,12 +1775,75 @@ </div> -<a name="methodparse_uri" id="parse_uri"><!-- --></a> +<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> <span class="var-name">$photo_idx</span>, <span class="var-type">int</span> <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">parse_uri</span> (line <span class="line-number">3104</span>) + <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> <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 ========= --> @@ -1592,11 +1872,11 @@ </div> <a name="methodresetDateSearch" id="resetDateSearch"><!-- --></a> -<div class="oddrow"> +<div class="evenrow"> <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">resetDateSearch</span> (line <span class="line-number">1104</span>) + <span class="method-title">resetDateSearch</span> (line <span class="line-number">1185</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1618,11 +1898,11 @@ </div> <a name="methodresetNameSearch" id="resetNameSearch"><!-- --></a> -<div class="evenrow"> +<div class="oddrow"> <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">resetNameSearch</span> (line <span class="line-number">1092</span>) + <span class="method-title">resetNameSearch</span> (line <span class="line-number">1173</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1644,11 +1924,11 @@ </div> <a name="methodresetPhotoView" id="resetPhotoView"><!-- --></a> -<div class="oddrow"> +<div class="evenrow"> <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">resetPhotoView</span> (line <span class="line-number">1068</span>) + <span class="method-title">resetPhotoView</span> (line <span class="line-number">1146</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1670,11 +1950,11 @@ </div> <a name="methodresetRateSearch" id="resetRateSearch"><!-- --></a> -<div class="evenrow"> +<div class="oddrow"> <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">resetRateSearch</span> (line <span class="line-number">1118</span>) + <span class="method-title">resetRateSearch</span> (line <span class="line-number">1199</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1696,11 +1976,11 @@ </div> <a name="methodresetSlideShow" id="resetSlideShow"><!-- --></a> -<div class="oddrow"> +<div class="evenrow"> <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">resetSlideShow</span> (line <span class="line-number">2806</span>) + <span class="method-title">resetSlideShow</span> (line <span class="line-number">3155</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1720,11 +2000,11 @@ </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">1003</span>) + <span class="method-title">resetTags</span> (line <span class="line-number">1081</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1746,11 +2026,11 @@ </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">1080</span>) + <span class="method-title">resetTagSearch</span> (line <span class="line-number">1161</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1772,11 +2052,11 @@ </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">2014</span>) + <span class="method-title">setTagCondition</span> (line <span class="line-number">2241</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1803,11 +2083,11 @@ </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">262</span>) + <span class="method-title">show</span> (line <span class="line-number">270</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1829,11 +2109,11 @@ </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">1578</span>) + <span class="method-title">showCredits</span> (line <span class="line-number">1676</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1854,11 +2134,11 @@ </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">662</span>) + <span class="method-title">showPhoto</span> (line <span class="line-number">723</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1885,11 +2165,11 @@ </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">1365</span>) + <span class="method-title">showPhotoIndex</span> (line <span class="line-number">1454</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1911,11 +2191,11 @@ </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">2264</span>) + <span class="method-title">showTextImage</span> (line <span class="line-number">2510</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1952,12 +2232,49 @@ </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> <span class="var-name">$params</span>, <span class="var-type"></span> <span class="var-name">&$smarty</span>, <span class="var-type">smarty</span> <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">2697</span>) + <span class="method-title">smarty_sort_select_list</span> (line <span class="line-number">3046</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -1993,7 +2310,7 @@ <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">startSearch</span> (line <span class="line-number">2032</span>) + <span class="method-title">startSearch</span> (line <span class="line-number">2259</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -2019,7 +2336,7 @@ <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">translate_path</span> (line <span class="line-number">649</span>) + <span class="method-title">translate_path</span> (line <span class="line-number">705</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -2050,7 +2367,7 @@ <div class="method-header"> <img src="../media/images/Method.png" /> - <span class="method-title">updateSortOrder</span> (line <span class="line-number">2106</span>) + <span class="method-title">updateSortOrder</span> (line <span class="line-number">2333</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -2079,12 +2396,46 @@ </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">2662</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> <span class="var-name">$photo_idx</span>, <span class="var-type">string</span> <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 ========= --> @@ -2106,11 +2457,11 @@ </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">2370</span>) + <span class="method-title">_error</span> (line <span class="line-number">2628</span>) </div> <!-- ========== Info from phpDoc block ========= --> @@ -2141,7 +2492,7 @@ <p class="notes" id="credit"> - 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> + 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 |