From 190c8dd8f2ef82917c3febbaa2e7aa09ada5dbb8 Mon Sep 17 00:00:00 2001 From: Andreas Unterkircher Date: Sun, 25 May 2008 10:49:05 +0200 Subject: update docs to version 1.5 Signed-off-by: Andreas Unterkircher --- docs/phpfspot/PHPFSPOT.html | 345 ++++++++++++++++++++++++++++++++++++-------- 1 file changed, 281 insertions(+), 64 deletions(-) (limited to 'docs/phpfspot/PHPFSPOT.html') diff --git a/docs/phpfspot/PHPFSPOT.html b/docs/phpfspot/PHPFSPOT.html index 33c8cb5..6b31c6b 100644 --- a/docs/phpfspot/PHPFSPOT.html +++ b/docs/phpfspot/PHPFSPOT.html @@ -97,7 +97,7 @@
-
+
PHPFSPOT __construct @@ -215,7 +215,7 @@ string getSelectedTags - () + ([ $type = 'link'])
@@ -230,6 +230,12 @@ (string $file)
+ + string + get_mime_info + (string $file) +
+
integer get_num_photos @@ -242,12 +248,36 @@ (integer $idx)
+ + integer + get_photo_rating + (integer $idx) +
+
array get_random_photo ()
+ + array + get_random_tag_photo + ( $tagidx) +
+
+ + string + get_rate_search + () +
+
+ + string + get_tag_name + (integer $idx) +
+
string get_thumb_path @@ -290,6 +320,12 @@ ()
+ + void + resetRateSearch + () +
+
void resetSlideShow @@ -333,7 +369,7 @@
- void + string showPhotoIndex ()
@@ -586,7 +622,7 @@
- Destructor __destruct (line 226) + Destructor __destruct (line 243)
@@ -610,7 +646,7 @@
- addTag (line 762) + addTag (line 925)
@@ -641,7 +677,7 @@
- checkifImageSupported (line 1979) + checkifImageSupported (line 2322)
@@ -671,7 +707,7 @@
- check_config_table (line 1518) + check_config_table (line 1818)
@@ -697,7 +733,7 @@
- cleanup_phpfspot_db (line 2745) + cleanup_phpfspot_db (line 3190)
@@ -723,11 +759,11 @@
- create_thumbnail (line 1351) + create_thumbnail (line 1571)
-

create_thumbnails for the requested width

+

create thumbnails for the requested width

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.

  • access: public
    • @@ -760,7 +796,7 @@
    - delTag (line 786) + delTag (line 954)
    @@ -791,7 +827,7 @@
    - gen_thumb (line 1546) + gen_thumb (line 1846)
    @@ -829,7 +865,7 @@
    - getAvailableTags (line 645) + getAvailableTags (line 791)
    @@ -855,7 +891,7 @@
    - getCurrentPhoto (line 2256) + getCurrentPhoto (line 2620)
    @@ -880,7 +916,7 @@
    - getExport (line 2125) + getExport (line 2475)
    @@ -910,7 +946,7 @@
    - getFspotDBVersion (line 2616) + getFspotDBVersion (line 3059)
    @@ -936,7 +972,7 @@
    - getMD5 (line 1630) + getMD5 (line 1948)
    @@ -967,7 +1003,7 @@
    - getNextSlideShowImage (line 2373) + getNextSlideShowImage (line 2740)
    @@ -993,7 +1029,7 @@
    - getPhotoName (line 454) + getPhotoName (line 522)
    @@ -1027,7 +1063,7 @@
    - getPhotoSelection (line 927) + getPhotoSelection (line 1108)
    @@ -1053,7 +1089,7 @@
    - getPrevSlideShowImage (line 2393) + getPrevSlideShowImage (line 2764)
    @@ -1079,7 +1115,7 @@
    - getRSSFeed (line 2167) + getRSSFeed (line 2522)
    @@ -1104,7 +1140,7 @@
    - getSelectedTags (line 729) + getSelectedTags (line 877)
    @@ -1119,9 +1155,14 @@ getSelectedTags - () + ([ $type = 'link'])
+
    +
  • + + $type
    • +
@@ -1130,7 +1171,7 @@
- get_calendar_matrix (line 2046) + get_calendar_matrix (line 2396)
@@ -1166,7 +1207,7 @@
- get_meta_informations (line 1505) + get_meta_informations (line 1805)
@@ -1191,12 +1232,43 @@
- +
- get_num_photos (line 2545) + get_mime_info (line 3251) +
+ + +

return mime info

+

this function tries to find out the correct mime-type for the provided file.

+
    +
  • access: public
    • +
+ +
+ string + + get_mime_info + + (string $file) +
+ +
    +
  • + string + $file
    • +
+ + +
+ +
+ +
+ + get_num_photos (line 2988)
@@ -1222,11 +1294,11 @@
-
+
- get_photo_details (line 395) + get_photo_details (line 454)
@@ -1251,13 +1323,44 @@ +
+ +
+ +
+ + get_photo_rating (line 546) +
+ + +

get photo rating level

+

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.

+
    +
  • access: public
    • +
+ +
+ integer + + get_photo_rating + + (integer $idx) +
+ +
    +
  • + integer + $idx: idx
    • +
+ +
- get_random_photo (line 2424) + get_random_photo (line 2799)
@@ -1278,12 +1381,100 @@
- + +
+ +
+ + get_random_tag_photo (line 2842) +
+ + +

get random photo tag photo

+

this function will get all photos tagged with the requested tag from the fspot database and randomly return ONE entry

saddly there is yet no sqlite3 function which returns the bulk result in array, so we have to fill up our own here.

+
    +
  • access: public
    • +
+ +
+ array + + get_random_tag_photo + + ( $tagidx) +
+ +
    +
  • + + $tagidx
    • +
+ + +
+ +
+ +
+ + get_rate_search (line 564) +
+ + +

get rate-search bars

+

this function will return the rating-bars for the search field.

+
    +
  • access: public
    • +
+ +
+ string + + get_rate_search + + () +
+ + + +
+
- get_thumb_path (line 2496) + get_tag_name (line 3278) +
+ + +

return tag-name by tag-idx

+

this function returns the tag-name for the requested tag specified by tag-idx.

+
    +
  • access: public
    • +
+ +
+ string + + get_tag_name + + (integer $idx) +
+ +
    +
  • + integer + $idx
    • +
+ + +
+ +
+ +
+ + get_thumb_path (line 2938)
@@ -1312,15 +1503,15 @@
-
+
- get_xml_tag_list (line 818) + get_xml_tag_list (line 986)
-

returns the value for the autocomplet tag-search

+

returns the value for the autocomplete tag-search

  • access: public
@@ -1337,11 +1528,11 @@
-
+
- isValidDate (line 2450) + isValidDate (line 2890)
@@ -1368,11 +1559,11 @@
-
+
- parse_uri (line 2636) + parse_uri (line 3079)
@@ -1401,16 +1592,16 @@
-
+
- resetDateSearch (line 909) + resetDateSearch (line 1076)

reset date search

-

if any date search has taken place, reset it now

+

if any date search has taken place, reset it now.

  • access: public
@@ -1427,11 +1618,11 @@
-
+
- resetNameSearch (line 896) + resetNameSearch (line 1064)
@@ -1453,11 +1644,11 @@
-
+
- resetPhotoView (line 872) + resetPhotoView (line 1040)
@@ -1477,13 +1668,39 @@ +
+ +
+ +
+ + resetRateSearch (line 1090) +
+ + +

reset rate search

+

if any rate search has taken place, reset it now.

+
    +
  • access: public
    • +
+ +
+ void + + resetRateSearch + + () +
+ + +
- resetSlideShow (line 2406) + resetSlideShow (line 2781)
@@ -1507,7 +1724,7 @@
- resetTags (line 807) + resetTags (line 975)
@@ -1533,7 +1750,7 @@
- resetTagSearch (line 884) + resetTagSearch (line 1052)
@@ -1559,7 +1776,7 @@
- setTagCondition (line 1668) + setTagCondition (line 1986)
@@ -1590,7 +1807,7 @@
- show (line 240) + show (line 257)
@@ -1616,7 +1833,7 @@
- showCredits (line 1330) + showCredits (line 1550)
@@ -1641,7 +1858,7 @@
- showPhoto (line 509) + showPhoto (line 646)
@@ -1672,7 +1889,7 @@
- showPhotoIndex (line 1131) + showPhotoIndex (line 1337)
@@ -1683,7 +1900,7 @@
- void + string showPhotoIndex @@ -1698,7 +1915,7 @@
- showTextImage (line 1893) + showTextImage (line 2236)
@@ -1740,7 +1957,7 @@
- smarty_sort_select_list (line 2311) + smarty_sort_select_list (line 2672)
@@ -1776,7 +1993,7 @@
- startSearch (line 1686) + startSearch (line 2004)
@@ -1802,7 +2019,7 @@
- translate_path (line 496) + translate_path (line 633)
@@ -1833,7 +2050,7 @@
- updateSortOrder (line 1738) + updateSortOrder (line 2078)
@@ -1867,7 +2084,7 @@
- whatToDo (line 2273) + whatToDo (line 2637)
@@ -1893,7 +2110,7 @@
- _error (line 1992) + _error (line 2342)
@@ -1924,7 +2141,7 @@

- Documentation generated on Sat, 12 Apr 2008 18:39:42 +0200 by phpDocumentor 1.4.2 + Documentation generated on Sun, 25 May 2008 10:46:25 +0200 by phpDocumentor 1.4.2

\ No newline at end of file -- cgit v1.2.3-18-g5258