From 478bae1a1072f2de18f46bf3fc3f0ce2643f4571 Mon Sep 17 00:00:00 2001 From: Andreas Unterkircher Date: Sat, 12 Apr 2008 18:25:30 +0200 Subject: commit current phpDocumentor docs --- docs/elementindex_phpfspot.html | 1012 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 1012 insertions(+) create mode 100644 docs/elementindex_phpfspot.html (limited to 'docs/elementindex_phpfspot.html') diff --git a/docs/elementindex_phpfspot.html b/docs/elementindex_phpfspot.html new file mode 100644 index 0000000..51cc660 --- /dev/null +++ b/docs/elementindex_phpfspot.html @@ -0,0 +1,1012 @@ + + + + + + + + + + + +

[phpfspot] element index

+All elements +
+
+ a + b + c + d + e + f + g + h + i + l + m + p + r + s + t + u + w + _ +
+ + +
+
_
+
top
+
+
+
+
+ Method + _error +
+
+
PHPFSPOT::_error() in phpfspot.class.php
+
output error text
+
+
+ Method + __construct +
+
+
PHPFSPOT_TMPL::__construct() in phpfspot_tmpl.php
+
class constructor
+
+
+ Method + __construct +
+
+
PHPFSPOT_RPC::__construct() in rpc.php
+
PHPFSPOT_RPC constructor
+
+
+ Method + __construct +
+
+
PHPFSPOT_IMG::__construct() in phpfspot_img.php
+
PHPFSPOT_IMG class constructor
+
+
+ Method + __construct +
+
+
PHPFSPOT_DB::__construct() in phpfspot_db.php
+
PHPFSPOT_DB class constructor
+
+
+ Method + __construct +
+
+
PHPFSPOT_CFG::__construct() in phpfspot_cfg.php
+
+
+ Method + __construct +
+
+
PHPFSPOT::__construct() in phpfspot.class.php
+
class constructor ($cfg, $db, $cfg_db, $tmpl, $db_ver)
+
+
+ Method + __destruct +
+
+
PHPFSPOT::__destruct() in phpfspot.class.php
+
+
+ Method + __destruct +
+
+
PHPFSPOT_IMG::__destruct() in phpfspot_img.php
+
PHPFSPOT_IMG class destructor
+
+
+ Method + __destruct +
+
+
PHPFSPOT_DB::__destruct() in phpfspot_db.php
+
PHPFSPOT_DB class deconstructor
+
+
+ +
+
a
+
top
+
+
+
+
+ Variable + $avail_tags +
+
+
PHPFSPOT::$avail_tags in phpfspot.class.php
+
list of available, not-selected, tags
+
+
+ Method + addTag +
+
+
PHPFSPOT::addTag() in phpfspot.class.php
+
add tag to users session variable
+
+
+ +
+
b
+
top
+
+
+
+
+ Variable + $base_path +
+
+
PHPFSPOT_CFG::$base_path in phpfspot_cfg.php
+
+
+ +
+
c
+
top
+
+
+
+
+ Variable + $cfg +
+
+
PHPFSPOT::$cfg in phpfspot.class.php
+
phpfspot configuration
+
+
+ Variable + $cfg_db +
+
+
PHPFSPOT::$cfg_db in phpfspot.class.php
+
SQLite database handle to phpfspot database
+
+
+ Method + checkifImageSupported +
+
+
PHPFSPOT::checkifImageSupported() in phpfspot.class.php
+
check if specified MIME type is supported
+
+
+ Method + check_config_table +
+
+
PHPFSPOT::check_config_table() in phpfspot.class.php
+
create phpfspot own sqlite database
+
+
+ Method + cleanup_phpfspot_db +
+
+
PHPFSPOT::cleanup_phpfspot_db() in phpfspot.class.php
+
cleanup phpfspot own database
+
+
+ Method + create_thumbnail +
+
+
PHPFSPOT::create_thumbnail() in phpfspot.class.php
+
create_thumbnails for the requested width
+
+
+ +
+
d
+
top
+
+
+
+
+ Variable + $db +
+
+
PHPFSPOT::$db in phpfspot.class.php
+
SQLite database handle to f-spot database
+
+
+ Variable + $db_access +
+
+
PHPFSPOT_CFG::$db_access in phpfspot_cfg.php
+
+
+ Method + db_check_table_exists +
+
+
PHPFSPOT_DB::db_check_table_exists() in phpfspot_db.php
+
PHPFSPOT_DB check table exists
+
+
+ Method + db_exec +
+
+
PHPFSPOT_DB::db_exec() in phpfspot_db.php
+
PHPFSPOT_DB database query & execute
+
+
+ Method + db_fetchSingleRow +
+
+
PHPFSPOT_DB::db_fetchSingleRow() in phpfspot_db.php
+
PHPFSPOT_DB fetch ONE row
+
+
+ Method + db_fetch_object +
+
+
PHPFSPOT_DB::db_fetch_object() in phpfspot_db.php
+
+
+ Method + db_getNumRows +
+
+
PHPFSPOT_DB::db_getNumRows() in phpfspot_db.php
+
PHPFSPOT_DB number of affected rows
+
+
+ Method + db_query +
+
+
PHPFSPOT_DB::db_query() in phpfspot_db.php
+
PHPFSPOT_DB database query
+
+
+ Method + delTag +
+
+
PHPFSPOT::delTag() in phpfspot.class.php
+
remove tag to users session variable
+
+
+ +
+
e
+
top
+
+
+
+
+ Variable + $error_found +
+
+
PHPFSPOT_CFG::$error_found in phpfspot_cfg.php
+
+
+ +
+
f
+
top
+
+
+
+
+ Variable + $fspot_db +
+
+
PHPFSPOT_CFG::$fspot_db in phpfspot_cfg.php
+
+
+ Page + find_dups.php +
+
+
find_dups.php in find_dups.php
+
+
+ +
+
g
+
top
+
+
+
+
+ Method + gen_thumb +
+
+
PHPFSPOT::gen_thumb() in phpfspot.class.php
+
Generates a thumbnail from photo idx
+
+
+ Page + gen_thumbs.php +
+
+
gen_thumbs.php in gen_thumbs.php
+
+
+ Method + getAvailableTags +
+
+
PHPFSPOT::getAvailableTags() in phpfspot.class.php
+
all available tags and tag cloud
+
+
+ Method + getCurrentPhoto +
+
+
PHPFSPOT::getCurrentPhoto() in phpfspot.class.php
+
return the current photo
+
+
+ Method + getExport +
+
+
PHPFSPOT::getExport() in phpfspot.class.php
+
output export page
+
+
+ Method + getFspotDBVersion +
+
+
PHPFSPOT::getFspotDBVersion() in phpfspot.class.php
+
retrive F-Spot database version
+
+
+ Method + getMD5 +
+
+
PHPFSPOT::getMD5() in phpfspot.class.php
+
returns stored md5 sum for a specific photo
+
+
+ Method + getNextSlideShowImage +
+
+
PHPFSPOT::getNextSlideShowImage() in phpfspot.class.php
+
return the next to be shown slide show image
+
+
+ Method + getPhotoName +
+
+
PHPFSPOT::getPhotoName() in phpfspot.class.php
+
returns aligned photo names
+
+
+ Method + getPhotoSelection +
+
+
PHPFSPOT::getPhotoSelection() in phpfspot.class.php
+
return all photo according selection
+
+
+ Method + getPrevSlideShowImage +
+
+
PHPFSPOT::getPrevSlideShowImage() in phpfspot.class.php
+
return the previous to be shown slide show image
+
+
+ Method + getRSSFeed +
+
+
PHPFSPOT::getRSSFeed() in phpfspot.class.php
+
output RSS feed
+
+
+ Method + getSelectedTags +
+
+
PHPFSPOT::getSelectedTags() in phpfspot.class.php
+
output all selected tags
+
+
+ Method + get_calendar_matrix +
+
+
PHPFSPOT::get_calendar_matrix() in phpfspot.class.php
+
output calendar matrix
+
+
+ Method + get_meta_informations +
+
+
PHPFSPOT::get_meta_informations() in phpfspot.class.php
+
return all exif meta data from the file
+
+
+ Method + get_num_photos +
+
+
PHPFSPOT::get_num_photos() in phpfspot.class.php
+
returns the number of photos which are tagged with $tag_id
+
+
+ Method + get_photo_details +
+
+
PHPFSPOT::get_photo_details() in phpfspot.class.php
+
extract all photo details
+
+
+ Method + get_random_photo +
+
+
PHPFSPOT::get_random_photo() in phpfspot.class.php
+
get random photo
+
+
+ Method + get_thumb_path +
+
+
PHPFSPOT::get_thumb_path() in phpfspot.class.php
+
returns the full path to a thumbnail
+
+
+ Method + get_xml_tag_list +
+
+
PHPFSPOT::get_xml_tag_list() in phpfspot.class.php
+
returns the value for the autocomplet tag-search
+
+
+ +
+
h
+
top
+
+
+
+
+ Variable + $hide_tags +
+
+
PHPFSPOT_CFG::$hide_tags in phpfspot_cfg.php
+
+
+ +
+
i
+
top
+
+
+
+
+ Page + index.php +
+
+
index.php in index.php
+
+
+ Method + isValidDate +
+
+
PHPFSPOT::isValidDate() in phpfspot.class.php
+
validates provided date
+
+
+ +
+
l
+
top
+
+
+
+
+ Variable + $logging +
+
+
PHPFSPOT_CFG::$logging in phpfspot_cfg.php
+
+
+ Variable + $log_file +
+
+
PHPFSPOT_CFG::$log_file in phpfspot_cfg.php
+
+
+ +
+
m
+
top
+
+
+
+
+ Variable + $mini_width +
+
+
PHPFSPOT_CFG::$mini_width in phpfspot_cfg.php
+
+
+ +
+
p
+
top
+
+
+
+
+ Variable + $page_title +
+
+
PHPFSPOT_CFG::$page_title in phpfspot_cfg.php
+
+
+ Variable + $path_replace_from +
+
+
PHPFSPOT_CFG::$path_replace_from in phpfspot_cfg.php
+
+
+ Variable + $path_replace_to +
+
+
PHPFSPOT_CFG::$path_replace_to in phpfspot_cfg.php
+
+
+ Variable + $photo_width +
+
+
PHPFSPOT_CFG::$photo_width in phpfspot_cfg.php
+
+
+ Variable + $phpfspot_db +
+
+
PHPFSPOT_CFG::$phpfspot_db in phpfspot_cfg.php
+
+
+ Method + parse_uri +
+
+
PHPFSPOT::parse_uri() in phpfspot.class.php
+
parse the provided URI and will returned the requested chunk
+
+
+ Class + PHPFSPOT +
+
+
PHPFSPOT in phpfspot.class.php
+
PHPFSPOT main class
+
+
+ Page + phpfspot.class.php +
+
+
phpfspot.class.php in phpfspot.class.php
+
+
+ Class + PHPFSPOT_CFG +
+
+
PHPFSPOT_CFG in phpfspot_cfg.php
+
+
+ Page + phpfspot_cfg.php +
+
+
phpfspot_cfg.php in phpfspot_cfg.php
+
+
+ Class + PHPFSPOT_DB +
+
+
PHPFSPOT_DB in phpfspot_db.php
+
PHPFSPOT_DB class
+
+
+ Page + phpfspot_db.php +
+
+
phpfspot_db.php in phpfspot_db.php
+
+
+ Class + PHPFSPOT_IMG +
+
+
PHPFSPOT_IMG in phpfspot_img.php
+
PHPFSPOT_IMG class
+
+
+ Page + phpfspot_img.php +
+
+
phpfspot_img.php in phpfspot_img.php
+
+
+ Class + PHPFSPOT_RPC +
+
+
PHPFSPOT_RPC in rpc.php
+
PHPFSPOT_RPC class
+
+
+ Class + PHPFSPOT_TMPL +
+
+
PHPFSPOT_TMPL in phpfspot_tmpl.php
+
PHPFSPOT_TMPL class
+
+
+ Page + phpfspot_tmpl.php +
+
+
phpfspot_tmpl.php in phpfspot_tmpl.php
+
+
+ Method + process_ajax_request +
+
+
PHPFSPOT_RPC::process_ajax_request() in rpc.php
+
+
+ +
+
r
+
top
+
+
+
+
+ Method + resetDateSearch +
+
+
PHPFSPOT::resetDateSearch() in phpfspot.class.php
+
reset date search
+
+
+ Method + resetNameSearch +
+
+
PHPFSPOT::resetNameSearch() in phpfspot.class.php
+
reset name search
+
+
+ Method + resetPhotoView +
+
+
PHPFSPOT::resetPhotoView() in phpfspot.class.php
+
reset single photo
+
+
+ Method + resetSlideShow +
+
+
PHPFSPOT::resetSlideShow() in phpfspot.class.php
+
+
+ Method + resetTags +
+
+
PHPFSPOT::resetTags() in phpfspot.class.php
+
reset tag selection
+
+
+ Method + resetTagSearch +
+
+
PHPFSPOT::resetTagSearch() in phpfspot.class.php
+
reset tag search
+
+
+ Page + rpc.php +
+
+
rpc.php in rpc.php
+
+
+ +
+
s
+
top
+
+
+
+
+ Variable + $smarty_path +
+
+
PHPFSPOT_CFG::$smarty_path in phpfspot_cfg.php
+
+
+ Method + setTagCondition +
+
+
PHPFSPOT::setTagCondition() in phpfspot.class.php
+
store current tag condition
+
+
+ Method + show +
+
+
PHPFSPOT_IMG::show() in phpfspot_img.php
+
sends the specified image to the browser
+
+
+ Method + show +
+
+
PHPFSPOT_TMPL::show() in phpfspot_tmpl.php
+
show template
+
+
+ Method + show +
+
+
PHPFSPOT::show() in phpfspot.class.php
+
show - generate html output
+
+
+ Method + showCredits +
+
+
PHPFSPOT::showCredits() in phpfspot.class.php
+
show credit template
+
+
+ Method + showPhoto +
+
+
PHPFSPOT::showPhoto() in phpfspot.class.php
+
control HTML ouput for a single photo
+
+
+ Method + showPhotoIndex +
+
+
PHPFSPOT::showPhotoIndex() in phpfspot.class.php
+
control HTML ouput for photo index
+
+
+ Method + showTextImage +
+
+
PHPFSPOT::showTextImage() in phpfspot.class.php
+
create on-the-fly images with text within
+
+
+ Method + smarty_sort_select_list +
+
+
PHPFSPOT::smarty_sort_select_list() in phpfspot.class.php
+
returns a select-dropdown box to select photo index sort parameters
+
+
+ Method + startSearch +
+
+
PHPFSPOT::startSearch() in phpfspot.class.php
+
invoke tag & date search
+
+
+ +
+
t
+
top
+
+
+
+
+ Variable + $tags +
+
+
PHPFSPOT::$tags in phpfspot.class.php
+
full tag - list
+
+
+ Variable + $theme_name +
+
+
PHPFSPOT_CFG::$theme_name in phpfspot_cfg.php
+
+
+ Variable + $thumbs_per_page +
+
+
PHPFSPOT_CFG::$thumbs_per_page in phpfspot_cfg.php
+
+
+ Variable + $thumb_height +
+
+
PHPFSPOT_CFG::$thumb_height in phpfspot_cfg.php
+
+
+ Variable + $thumb_path +
+
+
PHPFSPOT_CFG::$thumb_path in phpfspot_cfg.php
+
+
+ Variable + $thumb_width +
+
+
PHPFSPOT_CFG::$thumb_width in phpfspot_cfg.php
+
+
+ Variable + $tmpl +
+
+
PHPFSPOT::$tmpl in phpfspot.class.php
+
Smarty template engine
+
+
+ Method + translate_path +
+
+
PHPFSPOT::translate_path() in phpfspot.class.php
+
translate f-spoth photo path
+
+
+ +
+
u
+
top
+
+
+
+
+ Variable + $use_autocomplete +
+
+
PHPFSPOT_CFG::$use_autocomplete in phpfspot_cfg.php
+
+
+ Variable + $use_lightbox +
+
+
PHPFSPOT_CFG::$use_lightbox in phpfspot_cfg.php
+
+
+ Method + updateSortOrder +
+
+
PHPFSPOT::updateSortOrder() in phpfspot.class.php
+
updates sort order in session variable
+
+
+ +
+
w
+
top
+
+
+
+
+ Variable + $web_path +
+
+
PHPFSPOT_CFG::$web_path in phpfspot_cfg.php
+
+
+ Method + whatToDo +
+
+
PHPFSPOT::whatToDo() in phpfspot.class.php
+
tells the client browser what to do
+
+
+ +
+ a + b + c + d + e + f + g + h + i + l + m + p + r + s + t + u + w + _ +
+ \ No newline at end of file -- cgit v1.2.3-18-g5258 From 55677896eb839e20542440e51c5737a318240dab Mon Sep 17 00:00:00 2001 From: Andreas Unterkircher Date: Sat, 12 Apr 2008 18:40:20 +0200 Subject: update documentation Signed-off-by: Andreas Unterkircher --- docs/elementindex_phpfspot.html | 263 +++------------------------------------- 1 file changed, 19 insertions(+), 244 deletions(-) (limited to 'docs/elementindex_phpfspot.html') diff --git a/docs/elementindex_phpfspot.html b/docs/elementindex_phpfspot.html index 51cc660..8138e3a 100644 --- a/docs/elementindex_phpfspot.html +++ b/docs/elementindex_phpfspot.html @@ -14,16 +14,11 @@
a - b c d - e f g - h i - l - m p r s @@ -53,24 +48,16 @@ __construct
-
PHPFSPOT_TMPL::__construct() in phpfspot_tmpl.php
-
class constructor
-
-
- Method - __construct -
-
-
PHPFSPOT_RPC::__construct() in rpc.php
-
PHPFSPOT_RPC constructor
+
PHPFSPOT_IMG::__construct() in phpfspot_img.php
+
PHPFSPOT_IMG class constructor
Method __construct
-
PHPFSPOT_IMG::__construct() in phpfspot_img.php
-
PHPFSPOT_IMG class constructor
+
PHPFSPOT::__construct() in phpfspot.class.php
+
class constructor ($cfg, $db, $cfg_db, $tmpl, $db_ver)
Method @@ -85,38 +72,39 @@ __construct
-
PHPFSPOT_CFG::__construct() in phpfspot_cfg.php
+
PHPFSPOT_TMPL::__construct() in phpfspot_tmpl.php
+
PHPFSPOT_TMPL constructor
Method __construct
-
PHPFSPOT::__construct() in phpfspot.class.php
-
class constructor ($cfg, $db, $cfg_db, $tmpl, $db_ver)
+
PHPFSPOT_RPC::__construct() in rpc.php
+
PHPFSPOT_RPC constructor
Method __destruct
-
PHPFSPOT::__destruct() in phpfspot.class.php
+
PHPFSPOT_DB::__destruct() in phpfspot_db.php
+
PHPFSPOT_DB class deconstructor
Method __destruct
-
PHPFSPOT_IMG::__destruct() in phpfspot_img.php
-
PHPFSPOT_IMG class destructor
+
PHPFSPOT::__destruct() in phpfspot.class.php
Method __destruct
-
PHPFSPOT_DB::__destruct() in phpfspot_db.php
-
PHPFSPOT_DB class deconstructor
+
PHPFSPOT_IMG::__destruct() in phpfspot_img.php
+
PHPFSPOT_IMG class destructor
@@ -143,21 +131,6 @@
add tag to users session variable
- -
-
b
- -
-
-
-
- Variable - $base_path -
-
-
PHPFSPOT_CFG::$base_path in phpfspot_cfg.php
-
-
c
@@ -229,13 +202,6 @@
PHPFSPOT::$db in phpfspot.class.php
SQLite database handle to f-spot database
-
- Variable - $db_access -
-
-
PHPFSPOT_CFG::$db_access in phpfspot_cfg.php
-
Method db_check_table_exists @@ -292,21 +258,6 @@
remove tag to users session variable
- -
-
e
- -
-
-
-
- Variable - $error_found -
-
-
PHPFSPOT_CFG::$error_found in phpfspot_cfg.php
-
-
f
@@ -314,13 +265,6 @@
-
- Variable - $fspot_db -
-
-
PHPFSPOT_CFG::$fspot_db in phpfspot_cfg.php
-
Page find_dups.php @@ -496,21 +440,6 @@
returns the value for the autocomplet tag-search
- -
-
h
- -
-
-
-
- Variable - $hide_tags -
-
-
PHPFSPOT_CFG::$hide_tags in phpfspot_cfg.php
-
-
i
@@ -534,43 +463,6 @@
validates provided date
- -
-
l
- -
-
-
-
- Variable - $logging -
-
-
PHPFSPOT_CFG::$logging in phpfspot_cfg.php
-
-
- Variable - $log_file -
-
-
PHPFSPOT_CFG::$log_file in phpfspot_cfg.php
-
-
- -
-
m
- -
-
-
-
- Variable - $mini_width -
-
-
PHPFSPOT_CFG::$mini_width in phpfspot_cfg.php
-
-
p
@@ -578,41 +470,6 @@
-
- Variable - $page_title -
-
-
PHPFSPOT_CFG::$page_title in phpfspot_cfg.php
-
-
- Variable - $path_replace_from -
-
-
PHPFSPOT_CFG::$path_replace_from in phpfspot_cfg.php
-
-
- Variable - $path_replace_to -
-
-
PHPFSPOT_CFG::$path_replace_to in phpfspot_cfg.php
-
-
- Variable - $photo_width -
-
-
PHPFSPOT_CFG::$photo_width in phpfspot_cfg.php
-
-
- Variable - $phpfspot_db -
-
-
PHPFSPOT_CFG::$phpfspot_db in phpfspot_cfg.php
-
Method parse_uri @@ -638,20 +495,6 @@
Class - PHPFSPOT_CFG -
-
-
PHPFSPOT_CFG in phpfspot_cfg.php
-
-
- Page - phpfspot_cfg.php -
-
-
phpfspot_cfg.php in phpfspot_cfg.php
-
-
- Class PHPFSPOT_DB
@@ -780,13 +623,6 @@
-
- Variable - $smarty_path -
-
-
PHPFSPOT_CFG::$smarty_path in phpfspot_cfg.php
-
Method setTagCondition @@ -800,24 +636,24 @@ show
-
PHPFSPOT_IMG::show() in phpfspot_img.php
-
sends the specified image to the browser
+
PHPFSPOT_TMPL::show() in phpfspot_tmpl.php
+
show template
Method show
-
PHPFSPOT_TMPL::show() in phpfspot_tmpl.php
-
show template
+
PHPFSPOT::show() in phpfspot.class.php
+
show - generate html output
Method show
-
PHPFSPOT::show() in phpfspot.class.php
-
show - generate html output
+
PHPFSPOT_IMG::show() in phpfspot_img.php
+
sends the specified image to the browser
Method @@ -885,41 +721,6 @@
Variable - $theme_name -
-
-
PHPFSPOT_CFG::$theme_name in phpfspot_cfg.php
-
-
- Variable - $thumbs_per_page -
-
-
PHPFSPOT_CFG::$thumbs_per_page in phpfspot_cfg.php
-
-
- Variable - $thumb_height -
-
-
PHPFSPOT_CFG::$thumb_height in phpfspot_cfg.php
-
-
- Variable - $thumb_path -
-
-
PHPFSPOT_CFG::$thumb_path in phpfspot_cfg.php
-
-
- Variable - $thumb_width -
-
-
PHPFSPOT_CFG::$thumb_width in phpfspot_cfg.php
-
-
- Variable $tmpl
@@ -942,20 +743,6 @@
-
- Variable - $use_autocomplete -
-
-
PHPFSPOT_CFG::$use_autocomplete in phpfspot_cfg.php
-
-
- Variable - $use_lightbox -
-
-
PHPFSPOT_CFG::$use_lightbox in phpfspot_cfg.php
-
Method updateSortOrder @@ -972,13 +759,6 @@
-
- Variable - $web_path -
-
-
PHPFSPOT_CFG::$web_path in phpfspot_cfg.php
-
Method whatToDo @@ -991,16 +771,11 @@
a - b c d - e f g - h i - l - m p r s -- cgit v1.2.3-18-g5258