update docs to version 1.5
[phpfspot.git] / docs / elementindex_phpfspot.html
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3   <html xmlns="http://www.w3.org/1999/xhtml">
4                 <head>
5                         <!-- template designed by Marco Von Ballmoos -->
6                         <title></title>
7                         <link rel="stylesheet" href="media/stylesheet.css" />
8                         <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9                 </head>
10                 <body>
11                                                 <a name="top"></a>
12 <h2>[phpfspot] element index</h2>
13 <a href="elementindex.html">All elements</a>
14 <br />
15 <div class="index-letter-menu">
16         <a class="index-letter" href="elementindex_phpfspot.html#a">a</a>
17         <a class="index-letter" href="elementindex_phpfspot.html#c">c</a>
18         <a class="index-letter" href="elementindex_phpfspot.html#d">d</a>
19         <a class="index-letter" href="elementindex_phpfspot.html#f">f</a>
20         <a class="index-letter" href="elementindex_phpfspot.html#g">g</a>
21         <a class="index-letter" href="elementindex_phpfspot.html#i">i</a>
22         <a class="index-letter" href="elementindex_phpfspot.html#p">p</a>
23         <a class="index-letter" href="elementindex_phpfspot.html#r">r</a>
24         <a class="index-letter" href="elementindex_phpfspot.html#s">s</a>
25         <a class="index-letter" href="elementindex_phpfspot.html#t">t</a>
26         <a class="index-letter" href="elementindex_phpfspot.html#u">u</a>
27         <a class="index-letter" href="elementindex_phpfspot.html#w">w</a>
28         <a class="index-letter" href="elementindex_phpfspot.html#_">_</a>
29 </div>
30
31         <a name="_"></a>
32         <div class="index-letter-section">
33                 <div style="float: left" class="index-letter-title">_</div>
34                 <div style="float: right"><a href="#top">top</a></div>
35                 <div style="clear: both"></div>
36         </div>
37         <dl>
38                         <dt class="field">
39                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
40                         <span class="method-title">_error</span>
41                                         </dt>
42                 <dd class="index-item-body">
43                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#method_error">PHPFSPOT::_error()</a> in phpfspot.class.php</div>
44                                                         <div class="index-item-description">output error text</div>
45                                         </dd>
46                         <dt class="field">
47                                                 <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
48                         <span class="method-title">__construct</span>
49                                         </dt>
50                 <dd class="index-item-body">
51                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_IMG.html#method__construct">PHPFSPOT_IMG::__construct()</a> in phpfspot_img.php</div>
52                                                         <div class="index-item-description">PHPFSPOT_IMG class constructor</div>
53                                         </dd>
54                         <dt class="field">
55                                                 <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
56                         <span class="method-title">__construct</span>
57                                         </dt>
58                 <dd class="index-item-body">
59                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#method__construct">PHPFSPOT::__construct()</a> in phpfspot.class.php</div>
60                                                         <div class="index-item-description">class constructor ($cfg, $db, $cfg_db, $tmpl, $db_ver)</div>
61                                         </dd>
62                         <dt class="field">
63                                                 <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
64                         <span class="method-title">__construct</span>
65                                         </dt>
66                 <dd class="index-item-body">
67                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_DB.html#method__construct">PHPFSPOT_DB::__construct()</a> in phpfspot_db.php</div>
68                                                         <div class="index-item-description">PHPFSPOT_DB class constructor</div>
69                                         </dd>
70                         <dt class="field">
71                                                 <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
72                         <span class="method-title">__construct</span>
73                                         </dt>
74                 <dd class="index-item-body">
75                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_TMPL.html#method__construct">PHPFSPOT_TMPL::__construct()</a> in phpfspot_tmpl.php</div>
76                                                         <div class="index-item-description">PHPFSPOT_TMPL constructor</div>
77                                         </dd>
78                         <dt class="field">
79                                                 <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
80                         <span class="method-title">__construct</span>
81                                         </dt>
82                 <dd class="index-item-body">
83                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_RPC.html#method__construct">PHPFSPOT_RPC::__construct()</a> in rpc.php</div>
84                                                         <div class="index-item-description">PHPFSPOT_RPC constructor</div>
85                                         </dd>
86                         <dt class="field">
87                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
88                         <span class="method-title">__destruct</span>
89                                         </dt>
90                 <dd class="index-item-body">
91                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_DB.html#method__destruct">PHPFSPOT_DB::__destruct()</a> in phpfspot_db.php</div>
92                                                         <div class="index-item-description">PHPFSPOT_DB class deconstructor</div>
93                                         </dd>
94                         <dt class="field">
95                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
96                         <span class="method-title">__destruct</span>
97                                         </dt>
98                 <dd class="index-item-body">
99                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#method__destruct">PHPFSPOT::__destruct()</a> in phpfspot.class.php</div>
100                                         </dd>
101                         <dt class="field">
102                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
103                         <span class="method-title">__destruct</span>
104                                         </dt>
105                 <dd class="index-item-body">
106                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_IMG.html#method__destruct">PHPFSPOT_IMG::__destruct()</a> in phpfspot_img.php</div>
107                                                         <div class="index-item-description">PHPFSPOT_IMG class destructor</div>
108                                         </dd>
109                 </dl>
110         <a name="a"></a>
111         <div class="index-letter-section">
112                 <div style="float: left" class="index-letter-title">a</div>
113                 <div style="float: right"><a href="#top">top</a></div>
114                 <div style="clear: both"></div>
115         </div>
116         <dl>
117                         <dt class="field">
118                                                 <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
119                         <span class="var-title">$avail_tags</span>
120                                         </dt>
121                 <dd class="index-item-body">
122                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#var$avail_tags">PHPFSPOT::$avail_tags</a> in phpfspot.class.php</div>
123                                                         <div class="index-item-description">list of available, not-selected, tags</div>
124                                         </dd>
125                         <dt class="field">
126                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
127                         <span class="method-title">addTag</span>
128                                         </dt>
129                 <dd class="index-item-body">
130                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodaddTag">PHPFSPOT::addTag()</a> in phpfspot.class.php</div>
131                                                         <div class="index-item-description">add tag to users session variable</div>
132                                         </dd>
133                 </dl>
134         <a name="c"></a>
135         <div class="index-letter-section">
136                 <div style="float: left" class="index-letter-title">c</div>
137                 <div style="float: right"><a href="#top">top</a></div>
138                 <div style="clear: both"></div>
139         </div>
140         <dl>
141                         <dt class="field">
142                                                 <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
143                         <span class="var-title">$cfg</span>
144                                         </dt>
145                 <dd class="index-item-body">
146                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#var$cfg">PHPFSPOT::$cfg</a> in phpfspot.class.php</div>
147                                                         <div class="index-item-description">phpfspot configuration</div>
148                                         </dd>
149                         <dt class="field">
150                                                 <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
151                         <span class="var-title">$cfg_db</span>
152                                         </dt>
153                 <dd class="index-item-body">
154                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#var$cfg_db">PHPFSPOT::$cfg_db</a> in phpfspot.class.php</div>
155                                                         <div class="index-item-description">SQLite database handle to phpfspot database</div>
156                                         </dd>
157                         <dt class="field">
158                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
159                         <span class="method-title">checkifImageSupported</span>
160                                         </dt>
161                 <dd class="index-item-body">
162                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodcheckifImageSupported">PHPFSPOT::checkifImageSupported()</a> in phpfspot.class.php</div>
163                                                         <div class="index-item-description">check if specified MIME type is supported</div>
164                                         </dd>
165                         <dt class="field">
166                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
167                         <span class="method-title">check_config_table</span>
168                                         </dt>
169                 <dd class="index-item-body">
170                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodcheck_config_table">PHPFSPOT::check_config_table()</a> in phpfspot.class.php</div>
171                                                         <div class="index-item-description">create phpfspot own sqlite database</div>
172                                         </dd>
173                         <dt class="field">
174                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
175                         <span class="method-title">cleanup_phpfspot_db</span>
176                                         </dt>
177                 <dd class="index-item-body">
178                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodcleanup_phpfspot_db">PHPFSPOT::cleanup_phpfspot_db()</a> in phpfspot.class.php</div>
179                                                         <div class="index-item-description">cleanup phpfspot own database</div>
180                                         </dd>
181                         <dt class="field">
182                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
183                         <span class="method-title">create_thumbnail</span>
184                                         </dt>
185                 <dd class="index-item-body">
186                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodcreate_thumbnail">PHPFSPOT::create_thumbnail()</a> in phpfspot.class.php</div>
187                                                         <div class="index-item-description">create thumbnails for the requested width</div>
188                                         </dd>
189                 </dl>
190         <a name="d"></a>
191         <div class="index-letter-section">
192                 <div style="float: left" class="index-letter-title">d</div>
193                 <div style="float: right"><a href="#top">top</a></div>
194                 <div style="clear: both"></div>
195         </div>
196         <dl>
197                         <dt class="field">
198                                                 <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
199                         <span class="var-title">$db</span>
200                                         </dt>
201                 <dd class="index-item-body">
202                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#var$db">PHPFSPOT::$db</a> in phpfspot.class.php</div>
203                                                         <div class="index-item-description">SQLite database handle to f-spot database</div>
204                                         </dd>
205                         <dt class="field">
206                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
207                         <span class="method-title">db_check_table_exists</span>
208                                         </dt>
209                 <dd class="index-item-body">
210                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_DB.html#methoddb_check_table_exists">PHPFSPOT_DB::db_check_table_exists()</a> in phpfspot_db.php</div>
211                                                         <div class="index-item-description">PHPFSPOT_DB check table exists</div>
212                                         </dd>
213                         <dt class="field">
214                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
215                         <span class="method-title">db_exec</span>
216                                         </dt>
217                 <dd class="index-item-body">
218                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_DB.html#methoddb_exec">PHPFSPOT_DB::db_exec()</a> in phpfspot_db.php</div>
219                                                         <div class="index-item-description">PHPFSPOT_DB database query &amp; execute</div>
220                                         </dd>
221                         <dt class="field">
222                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
223                         <span class="method-title">db_fetchSingleRow</span>
224                                         </dt>
225                 <dd class="index-item-body">
226                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_DB.html#methoddb_fetchSingleRow">PHPFSPOT_DB::db_fetchSingleRow()</a> in phpfspot_db.php</div>
227                                                         <div class="index-item-description">PHPFSPOT_DB fetch ONE row</div>
228                                         </dd>
229                         <dt class="field">
230                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
231                         <span class="method-title">db_fetch_object</span>
232                                         </dt>
233                 <dd class="index-item-body">
234                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_DB.html#methoddb_fetch_object">PHPFSPOT_DB::db_fetch_object()</a> in phpfspot_db.php</div>
235                                         </dd>
236                         <dt class="field">
237                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
238                         <span class="method-title">db_getNumRows</span>
239                                         </dt>
240                 <dd class="index-item-body">
241                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_DB.html#methoddb_getNumRows">PHPFSPOT_DB::db_getNumRows()</a> in phpfspot_db.php</div>
242                                                         <div class="index-item-description">PHPFSPOT_DB number of affected rows</div>
243                                         </dd>
244                         <dt class="field">
245                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
246                         <span class="method-title">db_query</span>
247                                         </dt>
248                 <dd class="index-item-body">
249                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_DB.html#methoddb_query">PHPFSPOT_DB::db_query()</a> in phpfspot_db.php</div>
250                                                         <div class="index-item-description">PHPFSPOT_DB database query</div>
251                                         </dd>
252                         <dt class="field">
253                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
254                         <span class="method-title">delTag</span>
255                                         </dt>
256                 <dd class="index-item-body">
257                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methoddelTag">PHPFSPOT::delTag()</a> in phpfspot.class.php</div>
258                                                         <div class="index-item-description">remove tag to users session variable</div>
259                                         </dd>
260                 </dl>
261         <a name="f"></a>
262         <div class="index-letter-section">
263                 <div style="float: left" class="index-letter-title">f</div>
264                 <div style="float: right"><a href="#top">top</a></div>
265                 <div style="clear: both"></div>
266         </div>
267         <dl>
268                         <dt class="field">
269                                                 <img src="media/images/Page.png" alt="Page" title="Page" /></title>
270                         <span class="include-title">find_dups.php</span>
271                                         </dt>
272                 <dd class="index-item-body">
273                         <div class="index-item-details"><a href="phpfspot/_find_dups.php.html">find_dups.php</a> in find_dups.php</div>
274                                         </dd>
275                 </dl>
276         <a name="g"></a>
277         <div class="index-letter-section">
278                 <div style="float: left" class="index-letter-title">g</div>
279                 <div style="float: right"><a href="#top">top</a></div>
280                 <div style="clear: both"></div>
281         </div>
282         <dl>
283                         <dt class="field">
284                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
285                         <span class="method-title">gen_thumb</span>
286                                         </dt>
287                 <dd class="index-item-body">
288                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodgen_thumb">PHPFSPOT::gen_thumb()</a> in phpfspot.class.php</div>
289                                                         <div class="index-item-description">Generates a thumbnail from photo idx</div>
290                                         </dd>
291                         <dt class="field">
292                                                 <img src="media/images/Page.png" alt="Page" title="Page" /></title>
293                         <span class="include-title">gen_thumbs.php</span>
294                                         </dt>
295                 <dd class="index-item-body">
296                         <div class="index-item-details"><a href="phpfspot/_gen_thumbs.php.html">gen_thumbs.php</a> in gen_thumbs.php</div>
297                                         </dd>
298                         <dt class="field">
299                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
300                         <span class="method-title">getAvailableTags</span>
301                                         </dt>
302                 <dd class="index-item-body">
303                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodgetAvailableTags">PHPFSPOT::getAvailableTags()</a> in phpfspot.class.php</div>
304                                                         <div class="index-item-description">all available tags and tag cloud</div>
305                                         </dd>
306                         <dt class="field">
307                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
308                         <span class="method-title">getCurrentPhoto</span>
309                                         </dt>
310                 <dd class="index-item-body">
311                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodgetCurrentPhoto">PHPFSPOT::getCurrentPhoto()</a> in phpfspot.class.php</div>
312                                                         <div class="index-item-description">return the current photo</div>
313                                         </dd>
314                         <dt class="field">
315                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
316                         <span class="method-title">getExport</span>
317                                         </dt>
318                 <dd class="index-item-body">
319                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodgetExport">PHPFSPOT::getExport()</a> in phpfspot.class.php</div>
320                                                         <div class="index-item-description">output export page</div>
321                                         </dd>
322                         <dt class="field">
323                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
324                         <span class="method-title">getFspotDBVersion</span>
325                                         </dt>
326                 <dd class="index-item-body">
327                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodgetFspotDBVersion">PHPFSPOT::getFspotDBVersion()</a> in phpfspot.class.php</div>
328                                                         <div class="index-item-description">retrive F-Spot database version</div>
329                                         </dd>
330                         <dt class="field">
331                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
332                         <span class="method-title">getMD5</span>
333                                         </dt>
334                 <dd class="index-item-body">
335                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodgetMD5">PHPFSPOT::getMD5()</a> in phpfspot.class.php</div>
336                                                         <div class="index-item-description">returns stored md5 sum for a specific photo</div>
337                                         </dd>
338                         <dt class="field">
339                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
340                         <span class="method-title">getNextSlideShowImage</span>
341                                         </dt>
342                 <dd class="index-item-body">
343                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodgetNextSlideShowImage">PHPFSPOT::getNextSlideShowImage()</a> in phpfspot.class.php</div>
344                                                         <div class="index-item-description">return the next to be shown slide show image</div>
345                                         </dd>
346                         <dt class="field">
347                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
348                         <span class="method-title">getPhotoName</span>
349                                         </dt>
350                 <dd class="index-item-body">
351                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodgetPhotoName">PHPFSPOT::getPhotoName()</a> in phpfspot.class.php</div>
352                                                         <div class="index-item-description">returns aligned photo names</div>
353                                         </dd>
354                         <dt class="field">
355                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
356                         <span class="method-title">getPhotoSelection</span>
357                                         </dt>
358                 <dd class="index-item-body">
359                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodgetPhotoSelection">PHPFSPOT::getPhotoSelection()</a> in phpfspot.class.php</div>
360                                                         <div class="index-item-description">return all photo according selection</div>
361                                         </dd>
362                         <dt class="field">
363                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
364                         <span class="method-title">getPrevSlideShowImage</span>
365                                         </dt>
366                 <dd class="index-item-body">
367                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodgetPrevSlideShowImage">PHPFSPOT::getPrevSlideShowImage()</a> in phpfspot.class.php</div>
368                                                         <div class="index-item-description">return the previous to be shown slide show image</div>
369                                         </dd>
370                         <dt class="field">
371                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
372                         <span class="method-title">getRSSFeed</span>
373                                         </dt>
374                 <dd class="index-item-body">
375                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodgetRSSFeed">PHPFSPOT::getRSSFeed()</a> in phpfspot.class.php</div>
376                                                         <div class="index-item-description">output RSS feed</div>
377                                         </dd>
378                         <dt class="field">
379                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
380                         <span class="method-title">getSelectedTags</span>
381                                         </dt>
382                 <dd class="index-item-body">
383                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodgetSelectedTags">PHPFSPOT::getSelectedTags()</a> in phpfspot.class.php</div>
384                                                         <div class="index-item-description">output all selected tags</div>
385                                         </dd>
386                         <dt class="field">
387                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
388                         <span class="method-title">get_calendar_matrix</span>
389                                         </dt>
390                 <dd class="index-item-body">
391                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_calendar_matrix">PHPFSPOT::get_calendar_matrix()</a> in phpfspot.class.php</div>
392                                                         <div class="index-item-description">output calendar matrix</div>
393                                         </dd>
394                         <dt class="field">
395                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
396                         <span class="method-title">get_meta_informations</span>
397                                         </dt>
398                 <dd class="index-item-body">
399                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_meta_informations">PHPFSPOT::get_meta_informations()</a> in phpfspot.class.php</div>
400                                                         <div class="index-item-description">return all exif meta data from the file</div>
401                                         </dd>
402                         <dt class="field">
403                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
404                         <span class="method-title">get_mime_info</span>
405                                         </dt>
406                 <dd class="index-item-body">
407                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_mime_info">PHPFSPOT::get_mime_info()</a> in phpfspot.class.php</div>
408                                                         <div class="index-item-description">return mime info</div>
409                                         </dd>
410                         <dt class="field">
411                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
412                         <span class="method-title">get_num_photos</span>
413                                         </dt>
414                 <dd class="index-item-body">
415                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_num_photos">PHPFSPOT::get_num_photos()</a> in phpfspot.class.php</div>
416                                                         <div class="index-item-description">returns the number of photos which are tagged with $tag_id</div>
417                                         </dd>
418                         <dt class="field">
419                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
420                         <span class="method-title">get_photo_details</span>
421                                         </dt>
422                 <dd class="index-item-body">
423                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_photo_details">PHPFSPOT::get_photo_details()</a> in phpfspot.class.php</div>
424                                                         <div class="index-item-description">extract all photo details</div>
425                                         </dd>
426                         <dt class="field">
427                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
428                         <span class="method-title">get_photo_rating</span>
429                                         </dt>
430                 <dd class="index-item-body">
431                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_photo_rating">PHPFSPOT::get_photo_rating()</a> in phpfspot.class.php</div>
432                                                         <div class="index-item-description">get photo rating level</div>
433                                         </dd>
434                         <dt class="field">
435                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
436                         <span class="method-title">get_random_photo</span>
437                                         </dt>
438                 <dd class="index-item-body">
439                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_random_photo">PHPFSPOT::get_random_photo()</a> in phpfspot.class.php</div>
440                                                         <div class="index-item-description">get random photo</div>
441                                         </dd>
442                         <dt class="field">
443                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
444                         <span class="method-title">get_random_tag_photo</span>
445                                         </dt>
446                 <dd class="index-item-body">
447                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_random_tag_photo">PHPFSPOT::get_random_tag_photo()</a> in phpfspot.class.php</div>
448                                                         <div class="index-item-description">get random photo tag photo</div>
449                                         </dd>
450                         <dt class="field">
451                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
452                         <span class="method-title">get_rate_search</span>
453                                         </dt>
454                 <dd class="index-item-body">
455                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_rate_search">PHPFSPOT::get_rate_search()</a> in phpfspot.class.php</div>
456                                                         <div class="index-item-description">get rate-search bars</div>
457                                         </dd>
458                         <dt class="field">
459                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
460                         <span class="method-title">get_tag_name</span>
461                                         </dt>
462                 <dd class="index-item-body">
463                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_tag_name">PHPFSPOT::get_tag_name()</a> in phpfspot.class.php</div>
464                                                         <div class="index-item-description">return tag-name by tag-idx</div>
465                                         </dd>
466                         <dt class="field">
467                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
468                         <span class="method-title">get_thumb_path</span>
469                                         </dt>
470                 <dd class="index-item-body">
471                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_thumb_path">PHPFSPOT::get_thumb_path()</a> in phpfspot.class.php</div>
472                                                         <div class="index-item-description">returns the full path to a thumbnail</div>
473                                         </dd>
474                         <dt class="field">
475                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
476                         <span class="method-title">get_xml_tag_list</span>
477                                         </dt>
478                 <dd class="index-item-body">
479                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodget_xml_tag_list">PHPFSPOT::get_xml_tag_list()</a> in phpfspot.class.php</div>
480                                                         <div class="index-item-description">returns the value for the autocomplete tag-search</div>
481                                         </dd>
482                 </dl>
483         <a name="i"></a>
484         <div class="index-letter-section">
485                 <div style="float: left" class="index-letter-title">i</div>
486                 <div style="float: right"><a href="#top">top</a></div>
487                 <div style="clear: both"></div>
488         </div>
489         <dl>
490                         <dt class="field">
491                                                 <img src="media/images/Page.png" alt="Page" title="Page" /></title>
492                         <span class="include-title">index.php</span>
493                                         </dt>
494                 <dd class="index-item-body">
495                         <div class="index-item-details"><a href="phpfspot/_index.php.html">index.php</a> in index.php</div>
496                                         </dd>
497                         <dt class="field">
498                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
499                         <span class="method-title">isValidDate</span>
500                                         </dt>
501                 <dd class="index-item-body">
502                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodisValidDate">PHPFSPOT::isValidDate()</a> in phpfspot.class.php</div>
503                                                         <div class="index-item-description">validates provided date</div>
504                                         </dd>
505                 </dl>
506         <a name="p"></a>
507         <div class="index-letter-section">
508                 <div style="float: left" class="index-letter-title">p</div>
509                 <div style="float: right"><a href="#top">top</a></div>
510                 <div style="clear: both"></div>
511         </div>
512         <dl>
513                         <dt class="field">
514                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
515                         <span class="method-title">parse_uri</span>
516                                         </dt>
517                 <dd class="index-item-body">
518                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodparse_uri">PHPFSPOT::parse_uri()</a> in phpfspot.class.php</div>
519                                                         <div class="index-item-description">parse the provided URI and will returned the requested chunk</div>
520                                         </dd>
521                         <dt class="field">
522                                                 <img src="media/images/Class.png" alt="Class" title="Class" /></title>
523                         PHPFSPOT
524                                         </dt>
525                 <dd class="index-item-body">
526                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html">PHPFSPOT</a> in phpfspot.class.php</div>
527                                                         <div class="index-item-description">PHPFSPOT main class</div>
528                                         </dd>
529                         <dt class="field">
530                                                 <img src="media/images/Page.png" alt="Page" title="Page" /></title>
531                         <span class="include-title">phpfspot.class.php</span>
532                                         </dt>
533                 <dd class="index-item-body">
534                         <div class="index-item-details"><a href="phpfspot/_phpfspot.class.php.html">phpfspot.class.php</a> in phpfspot.class.php</div>
535                                         </dd>
536                         <dt class="field">
537                                                 <img src="media/images/Class.png" alt="Class" title="Class" /></title>
538                         PHPFSPOT_DB
539                                         </dt>
540                 <dd class="index-item-body">
541                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_DB.html">PHPFSPOT_DB</a> in phpfspot_db.php</div>
542                                                         <div class="index-item-description">PHPFSPOT_DB class</div>
543                                         </dd>
544                         <dt class="field">
545                                                 <img src="media/images/Page.png" alt="Page" title="Page" /></title>
546                         <span class="include-title">phpfspot_db.php</span>
547                                         </dt>
548                 <dd class="index-item-body">
549                         <div class="index-item-details"><a href="phpfspot/_phpfspot_db.php.html">phpfspot_db.php</a> in phpfspot_db.php</div>
550                                         </dd>
551                         <dt class="field">
552                                                 <img src="media/images/Class.png" alt="Class" title="Class" /></title>
553                         PHPFSPOT_IMG
554                                         </dt>
555                 <dd class="index-item-body">
556                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_IMG.html">PHPFSPOT_IMG</a> in phpfspot_img.php</div>
557                                                         <div class="index-item-description">PHPFSPOT_IMG class</div>
558                                         </dd>
559                         <dt class="field">
560                                                 <img src="media/images/Page.png" alt="Page" title="Page" /></title>
561                         <span class="include-title">phpfspot_img.php</span>
562                                         </dt>
563                 <dd class="index-item-body">
564                         <div class="index-item-details"><a href="phpfspot/_phpfspot_img.php.html">phpfspot_img.php</a> in phpfspot_img.php</div>
565                                         </dd>
566                         <dt class="field">
567                                                 <img src="media/images/Class.png" alt="Class" title="Class" /></title>
568                         PHPFSPOT_RPC
569                                         </dt>
570                 <dd class="index-item-body">
571                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_RPC.html">PHPFSPOT_RPC</a> in rpc.php</div>
572                                                         <div class="index-item-description">PHPFSPOT_RPC class</div>
573                                         </dd>
574                         <dt class="field">
575                                                 <img src="media/images/Class.png" alt="Class" title="Class" /></title>
576                         PHPFSPOT_TMPL
577                                         </dt>
578                 <dd class="index-item-body">
579                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_TMPL.html">PHPFSPOT_TMPL</a> in phpfspot_tmpl.php</div>
580                                                         <div class="index-item-description">PHPFSPOT_TMPL class</div>
581                                         </dd>
582                         <dt class="field">
583                                                 <img src="media/images/Page.png" alt="Page" title="Page" /></title>
584                         <span class="include-title">phpfspot_tmpl.php</span>
585                                         </dt>
586                 <dd class="index-item-body">
587                         <div class="index-item-details"><a href="phpfspot/_phpfspot_tmpl.php.html">phpfspot_tmpl.php</a> in phpfspot_tmpl.php</div>
588                                         </dd>
589                         <dt class="field">
590                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
591                         <span class="method-title">process_ajax_request</span>
592                                         </dt>
593                 <dd class="index-item-body">
594                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_RPC.html#methodprocess_ajax_request">PHPFSPOT_RPC::process_ajax_request()</a> in rpc.php</div>
595                                         </dd>
596                 </dl>
597         <a name="r"></a>
598         <div class="index-letter-section">
599                 <div style="float: left" class="index-letter-title">r</div>
600                 <div style="float: right"><a href="#top">top</a></div>
601                 <div style="clear: both"></div>
602         </div>
603         <dl>
604                         <dt class="field">
605                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
606                         <span class="method-title">resetDateSearch</span>
607                                         </dt>
608                 <dd class="index-item-body">
609                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodresetDateSearch">PHPFSPOT::resetDateSearch()</a> in phpfspot.class.php</div>
610                                                         <div class="index-item-description">reset date search</div>
611                                         </dd>
612                         <dt class="field">
613                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
614                         <span class="method-title">resetNameSearch</span>
615                                         </dt>
616                 <dd class="index-item-body">
617                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodresetNameSearch">PHPFSPOT::resetNameSearch()</a> in phpfspot.class.php</div>
618                                                         <div class="index-item-description">reset name search</div>
619                                         </dd>
620                         <dt class="field">
621                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
622                         <span class="method-title">resetPhotoView</span>
623                                         </dt>
624                 <dd class="index-item-body">
625                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodresetPhotoView">PHPFSPOT::resetPhotoView()</a> in phpfspot.class.php</div>
626                                                         <div class="index-item-description">reset single photo</div>
627                                         </dd>
628                         <dt class="field">
629                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
630                         <span class="method-title">resetRateSearch</span>
631                                         </dt>
632                 <dd class="index-item-body">
633                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodresetRateSearch">PHPFSPOT::resetRateSearch()</a> in phpfspot.class.php</div>
634                                                         <div class="index-item-description">reset rate search</div>
635                                         </dd>
636                         <dt class="field">
637                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
638                         <span class="method-title">resetSlideShow</span>
639                                         </dt>
640                 <dd class="index-item-body">
641                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodresetSlideShow">PHPFSPOT::resetSlideShow()</a> in phpfspot.class.php</div>
642                                         </dd>
643                         <dt class="field">
644                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
645                         <span class="method-title">resetTags</span>
646                                         </dt>
647                 <dd class="index-item-body">
648                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodresetTags">PHPFSPOT::resetTags()</a> in phpfspot.class.php</div>
649                                                         <div class="index-item-description">reset tag selection</div>
650                                         </dd>
651                         <dt class="field">
652                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
653                         <span class="method-title">resetTagSearch</span>
654                                         </dt>
655                 <dd class="index-item-body">
656                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodresetTagSearch">PHPFSPOT::resetTagSearch()</a> in phpfspot.class.php</div>
657                                                         <div class="index-item-description">reset tag search</div>
658                                         </dd>
659                         <dt class="field">
660                                                 <img src="media/images/Page.png" alt="Page" title="Page" /></title>
661                         <span class="include-title">rpc.php</span>
662                                         </dt>
663                 <dd class="index-item-body">
664                         <div class="index-item-details"><a href="phpfspot/_rpc.php.html">rpc.php</a> in rpc.php</div>
665                                         </dd>
666                 </dl>
667         <a name="s"></a>
668         <div class="index-letter-section">
669                 <div style="float: left" class="index-letter-title">s</div>
670                 <div style="float: right"><a href="#top">top</a></div>
671                 <div style="clear: both"></div>
672         </div>
673         <dl>
674                         <dt class="field">
675                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
676                         <span class="method-title">setTagCondition</span>
677                                         </dt>
678                 <dd class="index-item-body">
679                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodsetTagCondition">PHPFSPOT::setTagCondition()</a> in phpfspot.class.php</div>
680                                                         <div class="index-item-description">store current tag condition</div>
681                                         </dd>
682                         <dt class="field">
683                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
684                         <span class="method-title">show</span>
685                                         </dt>
686                 <dd class="index-item-body">
687                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodshow">PHPFSPOT::show()</a> in phpfspot.class.php</div>
688                                                         <div class="index-item-description">show - generate html output</div>
689                                         </dd>
690                         <dt class="field">
691                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
692                         <span class="method-title">show</span>
693                                         </dt>
694                 <dd class="index-item-body">
695                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_TMPL.html#methodshow">PHPFSPOT_TMPL::show()</a> in phpfspot_tmpl.php</div>
696                                                         <div class="index-item-description">show template</div>
697                                         </dd>
698                         <dt class="field">
699                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
700                         <span class="method-title">showCredits</span>
701                                         </dt>
702                 <dd class="index-item-body">
703                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodshowCredits">PHPFSPOT::showCredits()</a> in phpfspot.class.php</div>
704                                                         <div class="index-item-description">show credit template</div>
705                                         </dd>
706                         <dt class="field">
707                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
708                         <span class="method-title">showImg</span>
709                                         </dt>
710                 <dd class="index-item-body">
711                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_IMG.html#methodshowImg">PHPFSPOT_IMG::showImg()</a> in phpfspot_img.php</div>
712                                                         <div class="index-item-description">sends the specified image to the browser</div>
713                                         </dd>
714                         <dt class="field">
715                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
716                         <span class="method-title">showPhoto</span>
717                                         </dt>
718                 <dd class="index-item-body">
719                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodshowPhoto">PHPFSPOT::showPhoto()</a> in phpfspot.class.php</div>
720                                                         <div class="index-item-description">control HTML ouput for a single photo</div>
721                                         </dd>
722                         <dt class="field">
723                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
724                         <span class="method-title">showPhotoIndex</span>
725                                         </dt>
726                 <dd class="index-item-body">
727                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodshowPhotoIndex">PHPFSPOT::showPhotoIndex()</a> in phpfspot.class.php</div>
728                                                         <div class="index-item-description">control HTML ouput for photo index</div>
729                                         </dd>
730                         <dt class="field">
731                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
732                         <span class="method-title">showTagImg</span>
733                                         </dt>
734                 <dd class="index-item-body">
735                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT_IMG.html#methodshowTagImg">PHPFSPOT_IMG::showTagImg()</a> in phpfspot_img.php</div>
736                                                         <div class="index-item-description">sends a random photo of the requested tag to the browser</div>
737                                         </dd>
738                         <dt class="field">
739                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
740                         <span class="method-title">showTextImage</span>
741                                         </dt>
742                 <dd class="index-item-body">
743                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodshowTextImage">PHPFSPOT::showTextImage()</a> in phpfspot.class.php</div>
744                                                         <div class="index-item-description">create on-the-fly images with text within</div>
745                                         </dd>
746                         <dt class="field">
747                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
748                         <span class="method-title">smarty_sort_select_list</span>
749                                         </dt>
750                 <dd class="index-item-body">
751                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodsmarty_sort_select_list">PHPFSPOT::smarty_sort_select_list()</a> in phpfspot.class.php</div>
752                                                         <div class="index-item-description">returns a select-dropdown box to select photo index sort parameters</div>
753                                         </dd>
754                         <dt class="field">
755                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
756                         <span class="method-title">startSearch</span>
757                                         </dt>
758                 <dd class="index-item-body">
759                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodstartSearch">PHPFSPOT::startSearch()</a> in phpfspot.class.php</div>
760                                                         <div class="index-item-description">invoke tag &amp; date search</div>
761                                         </dd>
762                 </dl>
763         <a name="t"></a>
764         <div class="index-letter-section">
765                 <div style="float: left" class="index-letter-title">t</div>
766                 <div style="float: right"><a href="#top">top</a></div>
767                 <div style="clear: both"></div>
768         </div>
769         <dl>
770                         <dt class="field">
771                                                 <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
772                         <span class="var-title">$tags</span>
773                                         </dt>
774                 <dd class="index-item-body">
775                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#var$tags">PHPFSPOT::$tags</a> in phpfspot.class.php</div>
776                                                         <div class="index-item-description">full tag - list</div>
777                                         </dd>
778                         <dt class="field">
779                                                 <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
780                         <span class="var-title">$tmpl</span>
781                                         </dt>
782                 <dd class="index-item-body">
783                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#var$tmpl">PHPFSPOT::$tmpl</a> in phpfspot.class.php</div>
784                                                         <div class="index-item-description">Smarty template engine</div>
785                                         </dd>
786                         <dt class="field">
787                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
788                         <span class="method-title">translate_path</span>
789                                         </dt>
790                 <dd class="index-item-body">
791                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodtranslate_path">PHPFSPOT::translate_path()</a> in phpfspot.class.php</div>
792                                                         <div class="index-item-description">translate f-spoth photo path</div>
793                                         </dd>
794                 </dl>
795         <a name="u"></a>
796         <div class="index-letter-section">
797                 <div style="float: left" class="index-letter-title">u</div>
798                 <div style="float: right"><a href="#top">top</a></div>
799                 <div style="clear: both"></div>
800         </div>
801         <dl>
802                         <dt class="field">
803                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
804                         <span class="method-title">updateSortOrder</span>
805                                         </dt>
806                 <dd class="index-item-body">
807                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodupdateSortOrder">PHPFSPOT::updateSortOrder()</a> in phpfspot.class.php</div>
808                                                         <div class="index-item-description">updates sort order in session variable</div>
809                                         </dd>
810                 </dl>
811         <a name="w"></a>
812         <div class="index-letter-section">
813                 <div style="float: left" class="index-letter-title">w</div>
814                 <div style="float: right"><a href="#top">top</a></div>
815                 <div style="clear: both"></div>
816         </div>
817         <dl>
818                         <dt class="field">
819                                                 <img src="media/images/Method.png" alt="Method" title="Method" /></title>
820                         <span class="method-title">whatToDo</span>
821                                         </dt>
822                 <dd class="index-item-body">
823                         <div class="index-item-details"><a href="phpfspot/PHPFSPOT.html#methodwhatToDo">PHPFSPOT::whatToDo()</a> in phpfspot.class.php</div>
824                                                         <div class="index-item-description">tells the client browser what to do</div>
825                                         </dd>
826                 </dl>
827
828 <div class="index-letter-menu">
829         <a class="index-letter" href="elementindex_phpfspot.html#a">a</a>
830         <a class="index-letter" href="elementindex_phpfspot.html#c">c</a>
831         <a class="index-letter" href="elementindex_phpfspot.html#d">d</a>
832         <a class="index-letter" href="elementindex_phpfspot.html#f">f</a>
833         <a class="index-letter" href="elementindex_phpfspot.html#g">g</a>
834         <a class="index-letter" href="elementindex_phpfspot.html#i">i</a>
835         <a class="index-letter" href="elementindex_phpfspot.html#p">p</a>
836         <a class="index-letter" href="elementindex_phpfspot.html#r">r</a>
837         <a class="index-letter" href="elementindex_phpfspot.html#s">s</a>
838         <a class="index-letter" href="elementindex_phpfspot.html#t">t</a>
839         <a class="index-letter" href="elementindex_phpfspot.html#u">u</a>
840         <a class="index-letter" href="elementindex_phpfspot.html#w">w</a>
841         <a class="index-letter" href="elementindex_phpfspot.html#_">_</a>
842 </div>  </body>
843 </html>