X-Git-Url: https://git.nubati.net/cgi-bin/gitweb.cgi?p=phpfspot.git;a=blobdiff_plain;f=docs%2Fphpfspot%2FPHPFSPOT.html;h=de4a0f25656c46c2cc77cce443d2029a7f9320d8;hp=62e09476d34764167332c7b979d0d0128f5c43bd;hb=c1811f2887d9a888247ffb87b0b693ef1646dae0;hpb=1bd68ab30d8e8a95581ff26da1f8fadf12ce5d8d diff --git a/docs/phpfspot/PHPFSPOT.html b/docs/phpfspot/PHPFSPOT.html index 62e0947..de4a0f2 100644 --- a/docs/phpfspot/PHPFSPOT.html +++ b/docs/phpfspot/PHPFSPOT.html @@ -26,8 +26,9 @@

PHPFSPOT main class

+

this class contains the most functions which will to the major work for phpfspot.

- Located in /phpfspot.class.php (line 33) + Located in /phpfspot.class.php (line 36)

@@ -57,7 +58,7 @@
- PHPFSPOT_CFG + PHPFSPOT_CFG $cfg
@@ -96,7 +97,7 @@
-
+
PHPFSPOT __construct @@ -214,7 +215,7 @@ string getSelectedTags - () + ([ $type = 'link'])
@@ -229,6 +230,12 @@ (string $file)
+ + string + get_mime_info + (string $file) +
+
integer get_num_photos @@ -241,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 @@ -289,6 +320,12 @@ ()
+ + void + resetRateSearch + () +
+
void resetSlideShow @@ -332,7 +369,7 @@
- void + string showPhotoIndex ()
@@ -404,7 +441,7 @@ array $avail_tags - (line 80) + (line 83)
@@ -425,9 +462,9 @@
- PHPFSPOT_CFG + PHPFSPOT_CFG $cfg - (line 41) + (line 44)
@@ -451,7 +488,7 @@ PHPFSPOT_DB $cfg_db - (line 57) + (line 60)
@@ -475,7 +512,7 @@ PHPFSPOT_DB $db - (line 49) + (line 52)
@@ -499,7 +536,7 @@ array $tags - (line 73) + (line 76) @@ -522,7 +559,7 @@ PHPFSPOT_TMPL $tmpl - (line 66) + (line 69) @@ -559,7 +596,7 @@
- Constructor __construct (line 103) + Constructor __construct (line 106)
@@ -585,7 +622,7 @@
- Destructor __destruct (line 223) + Destructor __destruct (line 248)
@@ -609,7 +646,7 @@
- addTag (line 759) + addTag (line 953)
@@ -640,7 +677,7 @@
- checkifImageSupported (line 1976) + checkifImageSupported (line 2350)
@@ -670,7 +707,7 @@
- check_config_table (line 1515) + check_config_table (line 1846)
@@ -696,7 +733,7 @@
- cleanup_phpfspot_db (line 2742) + cleanup_phpfspot_db (line 3215)
@@ -722,11 +759,11 @@
- create_thumbnail (line 1348) + create_thumbnail (line 1599)
-

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.

+ + +
+ +
+ + get_photo_rating (line 562) +
+ + +

get photo rating level

+

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.

+ + +
+ integer + + get_photo_rating + + (integer $idx) +
+ + + +
- get_random_photo (line 2421) + get_random_photo (line 2824)
@@ -1277,12 +1381,100 @@
- + +
+ +
+ + get_random_tag_photo (line 2867) +
+ + +

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.

+ + +
+ array + + get_random_tag_photo + + ( $tagidx) +
+ + + + +
+ +
+ +
+ + get_rate_search (line 580) +
+ + +

get rate-search bars

+

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

+ + +
+ string + + get_rate_search + + () +
+ + + +
+
- get_thumb_path (line 2493) + get_tag_name (line 3303) +
+ + +

return tag-name by tag-idx

+

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

+ + +
+ string + + get_tag_name + + (integer $idx) +
+ + + + +
+ +
+ +
+ + get_thumb_path (line 2963)
@@ -1311,15 +1503,15 @@
-
+
- get_xml_tag_list (line 815) + get_xml_tag_list (line 1014)
-

returns the value for the autocomplet tag-search

+

returns the value for the autocomplete tag-search

@@ -1336,11 +1528,11 @@
-
+
- isValidDate (line 2447) + isValidDate (line 2915)
@@ -1367,11 +1559,11 @@
-
+
- parse_uri (line 2633) + parse_uri (line 3104)
@@ -1400,16 +1592,16 @@
-
+
- resetDateSearch (line 906) + resetDateSearch (line 1104)

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
@@ -1426,11 +1618,11 @@
-
+
- resetNameSearch (line 893) + resetNameSearch (line 1092)
@@ -1452,11 +1644,11 @@
-
+
- resetPhotoView (line 869) + resetPhotoView (line 1068)
@@ -1476,13 +1668,39 @@ +
+ +
+ +
+ + resetRateSearch (line 1118) +
+ + +

reset rate search

+

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

+
    +
  • access: public
    • +
+ +
+ void + + resetRateSearch + + () +
+ + +
- resetSlideShow (line 2403) + resetSlideShow (line 2806)
@@ -1506,7 +1724,7 @@
- resetTags (line 804) + resetTags (line 1003)
@@ -1532,7 +1750,7 @@
- resetTagSearch (line 881) + resetTagSearch (line 1080)
@@ -1558,7 +1776,7 @@
- setTagCondition (line 1665) + setTagCondition (line 2014)
@@ -1589,7 +1807,7 @@
- show (line 237) + show (line 262)
@@ -1615,7 +1833,7 @@
- showCredits (line 1327) + showCredits (line 1578)
@@ -1640,7 +1858,7 @@
- showPhoto (line 506) + showPhoto (line 662)
@@ -1671,7 +1889,7 @@
- showPhotoIndex (line 1128) + showPhotoIndex (line 1365)
@@ -1682,7 +1900,7 @@
- void + string showPhotoIndex @@ -1697,7 +1915,7 @@
- showTextImage (line 1890) + showTextImage (line 2264)
@@ -1739,7 +1957,7 @@
- smarty_sort_select_list (line 2308) + smarty_sort_select_list (line 2697)
@@ -1775,7 +1993,7 @@
- startSearch (line 1683) + startSearch (line 2032)
@@ -1801,7 +2019,7 @@
- translate_path (line 493) + translate_path (line 649)
@@ -1832,7 +2050,7 @@
- updateSortOrder (line 1735) + updateSortOrder (line 2106)
@@ -1866,7 +2084,7 @@
- whatToDo (line 2270) + whatToDo (line 2662)
@@ -1892,7 +2110,7 @@
- _error (line 1989) + _error (line 2370)
@@ -1923,7 +2141,7 @@

- Documentation generated on Sat, 12 Apr 2008 18:24:57 +0200 by phpDocumentor 1.4.2 + Documentation generated on Wed, 02 Jul 2008 20:40:55 +0200 by phpDocumentor 1.4.2

\ No newline at end of file