update docs to version 1.5
[phpfspot.git] / docs / phpfspot / 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>Docs For Class PHPFSPOT</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                         <div class="page-body">                 
12 <h2 class="class-name"><img src="../media/images/Class_logo.png"
13                                                                                                                 alt=" Class"
14                                                                                                                 title=" Class"
15                                                                                                                 style="vertical-align: middle"> PHPFSPOT</h2>
16
17 <a name="sec-description"></a>
18 <div class="info-box">
19         <div class="info-box-title">Description</div>
20         <div class="nav-bar">
21                                         <span class="disabled">Description</span> |
22                                                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
23                                                 |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
24                                                 
25                                         </div>
26         <div class="info-box-body">
27                         <!-- ========== Info from phpDoc block ========= -->
28 <p class="short-description">PHPFSPOT main class</p>
29 <p class="description"><p>this class contains the most functions which will to the major  work for phpfspot.</p></p>
30                 <p class="notes">
31                         Located in <a class="field" href="_phpfspot.class.php.html">/phpfspot.class.php</a> (line <span class="field">36</span>)
32                 </p>
33                 
34                                 
35                 <pre></pre>
36         
37                         </div>
38 </div>
39
40
41
42         <a name="sec-var-summary"></a>
43         <div class="info-box">
44                 <div class="info-box-title">Variable Summary</span></div>
45                 <div class="nav-bar">
46                         <a href="#sec-description">Description</a> |
47                                                 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
48                                                         | 
49                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
50                                                         
51                                                                 </div>
52                 <div class="info-box-body">
53                         <div class="var-summary">
54                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 <div class="var-title">
55                                         <img src="../media/images/Variable.png" alt=" " />
56                                         <span class="var-type">array</span>
57                                         <a href="#$avail_tags" title="details" class="var-name">$avail_tags</a>
58                                 </div>
59                                                                                                                                 <div class="var-title">
60                                         <img src="../media/images/Variable.png" alt=" " />
61                                         <span class="var-type">PHPFSPOT_CFG</span>
62                                         <a href="#$cfg" title="details" class="var-name">$cfg</a>
63                                 </div>
64                                                                                                                                 <div class="var-title">
65                                         <img src="../media/images/Variable.png" alt=" " />
66                                         <span class="var-type"><a href="../phpfspot/PHPFSPOT_DB.html">PHPFSPOT_DB</a></span>
67                                         <a href="#$cfg_db" title="details" class="var-name">$cfg_db</a>
68                                 </div>
69                                                                                                                                 <div class="var-title">
70                                         <img src="../media/images/Variable.png" alt=" " />
71                                         <span class="var-type"><a href="../phpfspot/PHPFSPOT_DB.html">PHPFSPOT_DB</a></span>
72                                         <a href="#$db" title="details" class="var-name">$db</a>
73                                 </div>
74                                                                                                                                 <div class="var-title">
75                                         <img src="../media/images/Variable.png" alt=" " />
76                                         <span class="var-type">array</span>
77                                         <a href="#$tags" title="details" class="var-name">$tags</a>
78                                 </div>
79                                                                                                                                 <div class="var-title">
80                                         <img src="../media/images/Variable.png" alt=" " />
81                                         <span class="var-type"><a href="../phpfspot/PHPFSPOT_TMPL.html">PHPFSPOT_TMPL</a></span>
82                                         <a href="#$tmpl" title="details" class="var-name">$tmpl</a>
83                                 </div>
84                                                                                         </div>
85                 </div>
86         </div>
87
88         <a name="sec-method-summary"></a>
89         <div class="info-box">
90                 <div class="info-box-title">Method Summary</span></div>
91                 <div class="nav-bar">
92                         <a href="#sec-description">Description</a> |
93                                                                                                                                                 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
94                                  
95                                 |
96                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
97                 </div>
98                 <div class="info-box-body">                     
99                         <div class="method-summary">
100                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 <div class="method-definition">
101                                         <img src="../media/images/Constructor.png" alt=" "/>
102                                                                                         <span class="method-result">PHPFSPOT</span>
103                                                                                 <a href="#__construct" title="details" class="method-name">__construct</a>
104                                                                                 ()
105                                                                         </div>
106                                                                                                                                 <div class="method-definition">
107                                         <img src="../media/images/Destructor.png" alt=" "/>
108                                                                                         <span class="method-result">void</span>
109                                                                                 <a href="#__destruct" title="details" class="method-name">__destruct</a>
110                                                                                 ()
111                                                                         </div>
112                                                                                                                                 <div class="method-definition">
113                                         <img src="../media/images/Method.png" alt=" "/>
114                                                                                         <span class="method-result">string</span>
115                                                                                 <a href="#addTag" title="details" class="method-name">addTag</a>
116                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$tag</span>)
117                                                                         </div>
118                                                                                                                                 <div class="method-definition">
119                                         <img src="../media/images/Method.png" alt=" "/>
120                                                                                         <span class="method-result">boolean</span>
121                                                                                 <a href="#checkifImageSupported" title="details" class="method-name">checkifImageSupported</a>
122                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$mime</span>)
123                                                                         </div>
124                                                                                                                                 <div class="method-definition">
125                                         <img src="../media/images/Method.png" alt=" "/>
126                                                                                         <span class="method-result">void</span>
127                                                                                 <a href="#check_config_table" title="details" class="method-name">check_config_table</a>
128                                                                                 ()
129                                                                         </div>
130                                                                                                                                 <div class="method-definition">
131                                         <img src="../media/images/Method.png" alt=" "/>
132                                                                                         <span class="method-result">void</span>
133                                                                                 <a href="#cleanup_phpfspot_db" title="details" class="method-name">cleanup_phpfspot_db</a>
134                                                                                 ()
135                                                                         </div>
136                                                                                                                                 <div class="method-definition">
137                                         <img src="../media/images/Method.png" alt=" "/>
138                                                                                         <span class="method-result">boolean</span>
139                                                                                 <a href="#create_thumbnail" title="details" class="method-name">create_thumbnail</a>
140                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$orig_image</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$thumb_image</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$width</span>)
141                                                                         </div>
142                                                                                                                                 <div class="method-definition">
143                                         <img src="../media/images/Method.png" alt=" "/>
144                                                                                         <span class="method-result">string</span>
145                                                                                 <a href="#delTag" title="details" class="method-name">delTag</a>
146                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$tag</span>)
147                                                                         </div>
148                                                                                                                                 <div class="method-definition">
149                                         <img src="../media/images/Method.png" alt=" "/>
150                                                                                         <span class="method-result">void</span>
151                                                                                 <a href="#gen_thumb" title="details" class="method-name">gen_thumb</a>
152                                                                                         ([<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$force</span> = <span class="var-default">0</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwrite</span> = <span class="var-default">false</span>])
153                                                                         </div>
154                                                                                                                                 <div class="method-definition">
155                                         <img src="../media/images/Method.png" alt=" "/>
156                                                                                         <span class="method-result">void</span>
157                                                                                 <a href="#getAvailableTags" title="details" class="method-name">getAvailableTags</a>
158                                                                                 ()
159                                                                         </div>
160                                                                                                                                 <div class="method-definition">
161                                         <img src="../media/images/Method.png" alt=" "/>
162                                                                                         <span class="method-result">void</span>
163                                                                                 <a href="#getCurrentPhoto" title="details" class="method-name">getCurrentPhoto</a>
164                                                                                 ()
165                                                                         </div>
166                                                                                                                                 <div class="method-definition">
167                                         <img src="../media/images/Method.png" alt=" "/>
168                                                                                         <span class="method-result">void</span>
169                                                                                 <a href="#getExport" title="details" class="method-name">getExport</a>
170                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$mode</span>)
171                                                                         </div>
172                                                                                                                                 <div class="method-definition">
173                                         <img src="../media/images/Method.png" alt=" "/>
174                                                                                         <span class="method-result">string|null</span>
175                                                                                 <a href="#getFspotDBVersion" title="details" class="method-name">getFspotDBVersion</a>
176                                                                                 ()
177                                                                         </div>
178                                                                                                                                 <div class="method-definition">
179                                         <img src="../media/images/Method.png" alt=" "/>
180                                                                                         <span class="method-result">string|null</span>
181                                                                                 <a href="#getMD5" title="details" class="method-name">getMD5</a>
182                                                                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
183                                                                         </div>
184                                                                                                                                 <div class="method-definition">
185                                         <img src="../media/images/Method.png" alt=" "/>
186                                                                                         <span class="method-result">string</span>
187                                                                                 <a href="#getNextSlideShowImage" title="details" class="method-name">getNextSlideShowImage</a>
188                                                                                 ()
189                                                                         </div>
190                                                                                                                                 <div class="method-definition">
191                                         <img src="../media/images/Method.png" alt=" "/>
192                                                                                         <span class="method-result">string|null</span>
193                                                                                 <a href="#getPhotoName" title="details" class="method-name">getPhotoName</a>
194                                                                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">0</span>])
195                                                                         </div>
196                                                                                                                                 <div class="method-definition">
197                                         <img src="../media/images/Method.png" alt=" "/>
198                                                                                         <span class="method-result">array</span>
199                                                                                 <a href="#getPhotoSelection" title="details" class="method-name">getPhotoSelection</a>
200                                                                                 ()
201                                                                         </div>
202                                                                                                                                 <div class="method-definition">
203                                         <img src="../media/images/Method.png" alt=" "/>
204                                                                                         <span class="method-result">string</span>
205                                                                                 <a href="#getPrevSlideShowImage" title="details" class="method-name">getPrevSlideShowImage</a>
206                                                                                 ()
207                                                                         </div>
208                                                                                                                                 <div class="method-definition">
209                                         <img src="../media/images/Method.png" alt=" "/>
210                                                                                         <span class="method-result">void</span>
211                                                                                 <a href="#getRSSFeed" title="details" class="method-name">getRSSFeed</a>
212                                                                                 ()
213                                                                         </div>
214                                                                                                                                 <div class="method-definition">
215                                         <img src="../media/images/Method.png" alt=" "/>
216                                                                                         <span class="method-result">string</span>
217                                                                                 <a href="#getSelectedTags" title="details" class="method-name">getSelectedTags</a>
218                                                                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'link'</span>])
219                                                                         </div>
220                                                                                                                                 <div class="method-definition">
221                                         <img src="../media/images/Method.png" alt=" "/>
222                                                                                         <span class="method-result">void</span>
223                                                                                 <a href="#get_calendar_matrix" title="details" class="method-name">get_calendar_matrix</a>
224                                                                                         ([<span class="var-type">integer</span>&nbsp;<span class="var-name">$year</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$month</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$day</span> = <span class="var-default">0</span>])
225                                                                         </div>
226                                                                                                                                 <div class="method-definition">
227                                         <img src="../media/images/Method.png" alt=" "/>
228                                                                                         <span class="method-result">array</span>
229                                                                                 <a href="#get_meta_informations" title="details" class="method-name">get_meta_informations</a>
230                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
231                                                                         </div>
232                                                                                                                                 <div class="method-definition">
233                                         <img src="../media/images/Method.png" alt=" "/>
234                                                                                         <span class="method-result">string</span>
235                                                                                 <a href="#get_mime_info" title="details" class="method-name">get_mime_info</a>
236                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
237                                                                         </div>
238                                                                                                                                 <div class="method-definition">
239                                         <img src="../media/images/Method.png" alt=" "/>
240                                                                                         <span class="method-result">integer</span>
241                                                                                 <a href="#get_num_photos" title="details" class="method-name">get_num_photos</a>
242                                                                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$tag_id</span>)
243                                                                         </div>
244                                                                                                                                 <div class="method-definition">
245                                         <img src="../media/images/Method.png" alt=" "/>
246                                                                                         <span class="method-result">object|null</span>
247                                                                                 <a href="#get_photo_details" title="details" class="method-name">get_photo_details</a>
248                                                                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
249                                                                         </div>
250                                                                                                                                 <div class="method-definition">
251                                         <img src="../media/images/Method.png" alt=" "/>
252                                                                                         <span class="method-result">integer</span>
253                                                                                 <a href="#get_photo_rating" title="details" class="method-name">get_photo_rating</a>
254                                                                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
255                                                                         </div>
256                                                                                                                                 <div class="method-definition">
257                                         <img src="../media/images/Method.png" alt=" "/>
258                                                                                         <span class="method-result">array</span>
259                                                                                 <a href="#get_random_photo" title="details" class="method-name">get_random_photo</a>
260                                                                                 ()
261                                                                         </div>
262                                                                                                                                 <div class="method-definition">
263                                         <img src="../media/images/Method.png" alt=" "/>
264                                                                                         <span class="method-result">array</span>
265                                                                                 <a href="#get_random_tag_photo" title="details" class="method-name">get_random_tag_photo</a>
266                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$tagidx</span>)
267                                                                         </div>
268                                                                                                                                 <div class="method-definition">
269                                         <img src="../media/images/Method.png" alt=" "/>
270                                                                                         <span class="method-result">string</span>
271                                                                                 <a href="#get_rate_search" title="details" class="method-name">get_rate_search</a>
272                                                                                 ()
273                                                                         </div>
274                                                                                                                                 <div class="method-definition">
275                                         <img src="../media/images/Method.png" alt=" "/>
276                                                                                         <span class="method-result">string</span>
277                                                                                 <a href="#get_tag_name" title="details" class="method-name">get_tag_name</a>
278                                                                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
279                                                                         </div>
280                                                                                                                                 <div class="method-definition">
281                                         <img src="../media/images/Method.png" alt=" "/>
282                                                                                         <span class="method-result">string</span>
283                                                                                 <a href="#get_thumb_path" title="details" class="method-name">get_thumb_path</a>
284                                                                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$width</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$photo</span>)
285                                                                         </div>
286                                                                                                                                 <div class="method-definition">
287                                         <img src="../media/images/Method.png" alt=" "/>
288                                                                                         <span class="method-result">string</span>
289                                                                                 <a href="#get_xml_tag_list" title="details" class="method-name">get_xml_tag_list</a>
290                                                                                 ()
291                                                                         </div>
292                                                                                                                                 <div class="method-definition">
293                                         <img src="../media/images/Method.png" alt=" "/>
294                                                                                         <span class="method-result">boolean</span>
295                                                                                 <a href="#isValidDate" title="details" class="method-name">isValidDate</a>
296                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$date_str</span>)
297                                                                         </div>
298                                                                                                                                 <div class="method-definition">
299                                         <img src="../media/images/Method.png" alt=" "/>
300                                                                                         <span class="method-result">string</span>
301                                                                                 <a href="#parse_uri" title="details" class="method-name">parse_uri</a>
302                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$uri</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$mode</span>)
303                                                                         </div>
304                                                                                                                                 <div class="method-definition">
305                                         <img src="../media/images/Method.png" alt=" "/>
306                                                                                         <span class="method-result">void</span>
307                                                                                 <a href="#resetDateSearch" title="details" class="method-name">resetDateSearch</a>
308                                                                                 ()
309                                                                         </div>
310                                                                                                                                 <div class="method-definition">
311                                         <img src="../media/images/Method.png" alt=" "/>
312                                                                                         <span class="method-result">void</span>
313                                                                                 <a href="#resetNameSearch" title="details" class="method-name">resetNameSearch</a>
314                                                                                 ()
315                                                                         </div>
316                                                                                                                                 <div class="method-definition">
317                                         <img src="../media/images/Method.png" alt=" "/>
318                                                                                         <span class="method-result">void</span>
319                                                                                 <a href="#resetPhotoView" title="details" class="method-name">resetPhotoView</a>
320                                                                                 ()
321                                                                         </div>
322                                                                                                                                 <div class="method-definition">
323                                         <img src="../media/images/Method.png" alt=" "/>
324                                                                                         <span class="method-result">void</span>
325                                                                                 <a href="#resetRateSearch" title="details" class="method-name">resetRateSearch</a>
326                                                                                 ()
327                                                                         </div>
328                                                                                                                                 <div class="method-definition">
329                                         <img src="../media/images/Method.png" alt=" "/>
330                                                                                         <span class="method-result">void</span>
331                                                                                 <a href="#resetSlideShow" title="details" class="method-name">resetSlideShow</a>
332                                                                                 ()
333                                                                         </div>
334                                                                                                                                 <div class="method-definition">
335                                         <img src="../media/images/Method.png" alt=" "/>
336                                                                                         <span class="method-result">void</span>
337                                                                                 <a href="#resetTags" title="details" class="method-name">resetTags</a>
338                                                                                 ()
339                                                                         </div>
340                                                                                                                                 <div class="method-definition">
341                                         <img src="../media/images/Method.png" alt=" "/>
342                                                                                         <span class="method-result">void</span>
343                                                                                 <a href="#resetTagSearch" title="details" class="method-name">resetTagSearch</a>
344                                                                                 ()
345                                                                         </div>
346                                                                                                                                 <div class="method-definition">
347                                         <img src="../media/images/Method.png" alt=" "/>
348                                                                                         <span class="method-result">string</span>
349                                                                                 <a href="#setTagCondition" title="details" class="method-name">setTagCondition</a>
350                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$mode</span>)
351                                                                         </div>
352                                                                                                                                 <div class="method-definition">
353                                         <img src="../media/images/Method.png" alt=" "/>
354                                                                                         <span class="method-result">void</span>
355                                                                                 <a href="#show" title="details" class="method-name">show</a>
356                                                                                 ()
357                                                                         </div>
358                                                                                                                                 <div class="method-definition">
359                                         <img src="../media/images/Method.png" alt=" "/>
360                                                                                         <span class="method-result">void</span>
361                                                                                 <a href="#showCredits" title="details" class="method-name">showCredits</a>
362                                                                                 ()
363                                                                         </div>
364                                                                                                                                 <div class="method-definition">
365                                         <img src="../media/images/Method.png" alt=" "/>
366                                                                                         <span class="method-result">void</span>
367                                                                                 <a href="#showPhoto" title="details" class="method-name">showPhoto</a>
368                                                                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$photo</span>)
369                                                                         </div>
370                                                                                                                                 <div class="method-definition">
371                                         <img src="../media/images/Method.png" alt=" "/>
372                                                                                         <span class="method-result">string</span>
373                                                                                 <a href="#showPhotoIndex" title="details" class="method-name">showPhotoIndex</a>
374                                                                                 ()
375                                                                         </div>
376                                                                                                                                 <div class="method-definition">
377                                         <img src="../media/images/Method.png" alt=" "/>
378                                                                                         <span class="method-result">void</span>
379                                                                                 <a href="#showTextImage" title="details" class="method-name">showTextImage</a>
380                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$txt</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$color</span> = <span class="var-default">000000</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$space</span> = <span class="var-default">4</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$font</span> = <span class="var-default">4</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$w</span> = <span class="var-default">300</span>])
381                                                                         </div>
382                                                                                                                                 <div class="method-definition">
383                                         <img src="../media/images/Method.png" alt=" "/>
384                                                                                         <span class="method-result">string</span>
385                                                                                 <a href="#smarty_sort_select_list" title="details" class="method-name">smarty_sort_select_list</a>
386                                                                                         (<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$smarty</span>, <span class="var-type">smarty</span>&nbsp;<span class="var-name">$smarty</span>)
387                                                                         </div>
388                                                                                                                                 <div class="method-definition">
389                                         <img src="../media/images/Method.png" alt=" "/>
390                                                                                         <span class="method-result">string</span>
391                                                                                 <a href="#startSearch" title="details" class="method-name">startSearch</a>
392                                                                                 ()
393                                                                         </div>
394                                                                                                                                 <div class="method-definition">
395                                         <img src="../media/images/Method.png" alt=" "/>
396                                                                                         <span class="method-result">string</span>
397                                                                                 <a href="#translate_path" title="details" class="method-name">translate_path</a>
398                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
399                                                                         </div>
400                                                                                                                                 <div class="method-definition">
401                                         <img src="../media/images/Method.png" alt=" "/>
402                                                                                         <span class="method-result">string</span>
403                                                                                 <a href="#updateSortOrder" title="details" class="method-name">updateSortOrder</a>
404                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$order</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$sort_order</span>)
405                                                                         </div>
406                                                                                                                                 <div class="method-definition">
407                                         <img src="../media/images/Method.png" alt=" "/>
408                                                                                         <span class="method-result">string</span>
409                                                                                 <a href="#whatToDo" title="details" class="method-name">whatToDo</a>
410                                                                                 ()
411                                                                         </div>
412                                                                                                                                 <div class="method-definition">
413                                         <img src="../media/images/Method.png" alt=" "/>
414                                                                                         <span class="method-result">void</span>
415                                                                                 <a href="#_error" title="details" class="method-name">_error</a>
416                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
417                                                                         </div>
418                                                                                         </div>
419                 </div>
420         </div>          
421
422         <a name="sec-vars"></a>
423         <div class="info-box">
424                 <div class="info-box-title">Variables</div>
425                 <div class="nav-bar">
426                         <a href="#sec-description">Description</a> |
427                                                                                 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
428                                                 
429                         
430                                                                                 | 
431                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
432                                                         
433                                         </div>
434                 <div class="info-box-body">
435                         
436 <a name="var$avail_tags" id="$avail_tags"><!-- --></A>
437 <div class="oddrow">
438
439         <div class="var-header">
440                 <img src="../media/images/Variable.png" />
441                 <span class="var-title">
442                         <span class="var-type">array</span>
443                         <span class="var-name">$avail_tags</span>
444                                                 (line <span class="line-number">83</span>)
445                 </span>
446         </div>
447
448         <!-- ========== Info from phpDoc block ========= -->
449 <p class="short-description">list of available, not-selected, tags</p>
450         <ul class="tags">
451                                 <li><span class="field">access:</span> public</li>
452                         </ul>
453         
454         
455                 
456                 
457
458 </div>
459 <a name="var$cfg" id="$cfg"><!-- --></A>
460 <div class="evenrow">
461
462         <div class="var-header">
463                 <img src="../media/images/Variable.png" />
464                 <span class="var-title">
465                         <span class="var-type">PHPFSPOT_CFG</span>
466                         <span class="var-name">$cfg</span>
467                                                 (line <span class="line-number">44</span>)
468                 </span>
469         </div>
470
471         <!-- ========== Info from phpDoc block ========= -->
472 <p class="short-description">phpfspot configuration</p>
473         <ul class="tags">
474                                 <li><span class="field">see:</span> PHPFSPOT_CFG()</li>
475                                 <li><span class="field">access:</span> public</li>
476                         </ul>
477         
478         
479                 
480                 
481
482 </div>
483 <a name="var$cfg_db" id="$cfg_db"><!-- --></A>
484 <div class="oddrow">
485
486         <div class="var-header">
487                 <img src="../media/images/Variable.png" />
488                 <span class="var-title">
489                         <span class="var-type"><a href="../phpfspot/PHPFSPOT_DB.html">PHPFSPOT_DB</a></span>
490                         <span class="var-name">$cfg_db</span>
491                                                 (line <span class="line-number">60</span>)
492                 </span>
493         </div>
494
495         <!-- ========== Info from phpDoc block ========= -->
496 <p class="short-description">SQLite database handle to phpfspot database</p>
497         <ul class="tags">
498                                 <li><span class="field">see:</span> PHPFSPOT_DB()</li>
499                                 <li><span class="field">access:</span> public</li>
500                         </ul>
501         
502         
503                 
504                 
505
506 </div>
507 <a name="var$db" id="$db"><!-- --></A>
508 <div class="evenrow">
509
510         <div class="var-header">
511                 <img src="../media/images/Variable.png" />
512                 <span class="var-title">
513                         <span class="var-type"><a href="../phpfspot/PHPFSPOT_DB.html">PHPFSPOT_DB</a></span>
514                         <span class="var-name">$db</span>
515                                                 (line <span class="line-number">52</span>)
516                 </span>
517         </div>
518
519         <!-- ========== Info from phpDoc block ========= -->
520 <p class="short-description">SQLite database handle to f-spot database</p>
521         <ul class="tags">
522                                 <li><span class="field">see:</span> PHPFSPOT_DB()</li>
523                                 <li><span class="field">access:</span> public</li>
524                         </ul>
525         
526         
527                 
528                 
529
530 </div>
531 <a name="var$tags" id="$tags"><!-- --></A>
532 <div class="oddrow">
533
534         <div class="var-header">
535                 <img src="../media/images/Variable.png" />
536                 <span class="var-title">
537                         <span class="var-type">array</span>
538                         <span class="var-name">$tags</span>
539                                                 (line <span class="line-number">76</span>)
540                 </span>
541         </div>
542
543         <!-- ========== Info from phpDoc block ========= -->
544 <p class="short-description">full tag - list</p>
545         <ul class="tags">
546                                 <li><span class="field">access:</span> public</li>
547                         </ul>
548         
549         
550                 
551                 
552
553 </div>
554 <a name="var$tmpl" id="$tmpl"><!-- --></A>
555 <div class="evenrow">
556
557         <div class="var-header">
558                 <img src="../media/images/Variable.png" />
559                 <span class="var-title">
560                         <span class="var-type"><a href="../phpfspot/PHPFSPOT_TMPL.html">PHPFSPOT_TMPL</a></span>
561                         <span class="var-name">$tmpl</span>
562                                                 (line <span class="line-number">69</span>)
563                 </span>
564         </div>
565
566         <!-- ========== Info from phpDoc block ========= -->
567 <p class="short-description">Smarty template engine</p>
568         <ul class="tags">
569                                 <li><span class="field">see:</span> PHPFSPOT_TMPL()</li>
570                                 <li><span class="field">link:</span> <a href="http://smarty.php.net">http://smarty.php.net smarty.php.net</a></li>
571                                 <li><span class="field">access:</span> public</li>
572                         </ul>
573         
574         
575                 
576                 
577
578 </div>
579                                                 
580                 </div>
581         </div>
582         
583         <a name="sec-methods"></a>
584         <div class="info-box">
585                 <div class="info-box-title">Methods</div>
586                 <div class="nav-bar">
587                         <a href="#sec-description">Description</a> |
588                                                                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
589                                                                                                                 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
590                                                 
591                 </div>
592                 <div class="info-box-body">
593                         <A NAME='method_detail'></A>
594 <a name="method__construct" id="__construct"><!-- --></a>
595 <div class="oddrow">
596         
597         <div class="method-header">
598                 <img src="../media/images/Constructor.png" />
599                 <span class="method-title">Constructor __construct</span> (line <span class="line-number">106</span>)
600         </div> 
601         
602         <!-- ========== Info from phpDoc block ========= -->
603 <p class="short-description">class constructor ($cfg, $db, $cfg_db, $tmpl, $db_ver)</p>
604 <p class="description"><p>this function will be called on class construct  and will check requirements, loads configuration,  open databases and start the user session</p></p>
605         <ul class="tags">
606                                 <li><span class="field">access:</span> public</li>
607                         </ul>
608         
609         <div class="method-signature">
610                 <span class="method-result">PHPFSPOT</span>
611                 <span class="method-name">
612                         __construct
613                 </span>
614                                 ()
615                         </div>
616         
617                 
618                         
619         </div>
620 <a name="method__destruct" id="__destruct"><!-- --></a>
621 <div class="evenrow">
622         
623         <div class="method-header">
624                 <img src="../media/images/Destructor.png" />
625                 <span class="method-title">Destructor __destruct</span> (line <span class="line-number">243</span>)
626         </div> 
627         
628         <!-- ========== Info from phpDoc block ========= -->
629         <ul class="tags">
630                                 <li><span class="field">access:</span> public</li>
631                         </ul>
632         
633         <div class="method-signature">
634                 <span class="method-result">void</span>
635                 <span class="method-name">
636                         __destruct
637                 </span>
638                                 ()
639                         </div>
640         
641                 
642                         
643         </div>
644 <a name="methodaddTag" id="addTag"><!-- --></a>
645 <div class="oddrow">
646         
647         <div class="method-header">
648                 <img src="../media/images/Method.png" />
649                 <span class="method-title">addTag</span> (line <span class="line-number">925</span>)
650         </div> 
651         
652         <!-- ========== Info from phpDoc block ========= -->
653 <p class="short-description">add tag to users session variable</p>
654 <p class="description"><p>this function will add the specified to users current  tag selection. if a date search has been made before  it will be now cleared</p></p>
655         <ul class="tags">
656                                 <li><span class="field">access:</span> public</li>
657                         </ul>
658         
659         <div class="method-signature">
660                 <span class="method-result">string</span>
661                 <span class="method-name">
662                         addTag
663                 </span>
664                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$tag</span>)
665                         </div>
666         
667                         <ul class="parameters">
668                                         <li>
669                                 <span class="var-type"></span>
670                                 <span class="var-name">$tag</span>                      </li>
671                                 </ul>
672                 
673                         
674         </div>
675 <a name="methodcheckifImageSupported" id="checkifImageSupported"><!-- --></a>
676 <div class="evenrow">
677         
678         <div class="method-header">
679                 <img src="../media/images/Method.png" />
680                 <span class="method-title">checkifImageSupported</span> (line <span class="line-number">2322</span>)
681         </div> 
682         
683         <!-- ========== Info from phpDoc block ========= -->
684 <p class="short-description">check if specified MIME type is supported</p>
685         <ul class="tags">
686                                 <li><span class="field">access:</span> public</li>
687                         </ul>
688         
689         <div class="method-signature">
690                 <span class="method-result">boolean</span>
691                 <span class="method-name">
692                         checkifImageSupported
693                 </span>
694                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$mime</span>)
695                         </div>
696         
697                         <ul class="parameters">
698                                         <li>
699                                 <span class="var-type">string</span>
700                                 <span class="var-name">$mime</span>                     </li>
701                                 </ul>
702                 
703                         
704         </div>
705 <a name="methodcheck_config_table" id="check_config_table"><!-- --></a>
706 <div class="oddrow">
707         
708         <div class="method-header">
709                 <img src="../media/images/Method.png" />
710                 <span class="method-title">check_config_table</span> (line <span class="line-number">1818</span>)
711         </div> 
712         
713         <!-- ========== Info from phpDoc block ========= -->
714 <p class="short-description">create phpfspot own sqlite database</p>
715 <p class="description"><p>this function creates phpfspots own sqlite database  if it does not exist yet. this own is used to store  some necessary informations (md5 sum's, ...).</p></p>
716         <ul class="tags">
717                                 <li><span class="field">access:</span> public</li>
718                         </ul>
719         
720         <div class="method-signature">
721                 <span class="method-result">void</span>
722                 <span class="method-name">
723                         check_config_table
724                 </span>
725                                 ()
726                         </div>
727         
728                 
729                         
730         </div>
731 <a name="methodcleanup_phpfspot_db" id="cleanup_phpfspot_db"><!-- --></a>
732 <div class="evenrow">
733         
734         <div class="method-header">
735                 <img src="../media/images/Method.png" />
736                 <span class="method-title">cleanup_phpfspot_db</span> (line <span class="line-number">3190</span>)
737         </div> 
738         
739         <!-- ========== Info from phpDoc block ========= -->
740 <p class="short-description">cleanup phpfspot own database</p>
741 <p class="description"><p>When photos are getting delete from F-Spot, there will remain  remain some residues in phpfspot own database. This function  will try to wipe them out.</p></p>
742         <ul class="tags">
743                                 <li><span class="field">access:</span> public</li>
744                         </ul>
745         
746         <div class="method-signature">
747                 <span class="method-result">void</span>
748                 <span class="method-name">
749                         cleanup_phpfspot_db
750                 </span>
751                                 ()
752                         </div>
753         
754                 
755                         
756         </div>
757 <a name="methodcreate_thumbnail" id="create_thumbnail"><!-- --></a>
758 <div class="oddrow">
759         
760         <div class="method-header">
761                 <img src="../media/images/Method.png" />
762                 <span class="method-title">create_thumbnail</span> (line <span class="line-number">1571</span>)
763         </div> 
764         
765         <!-- ========== Info from phpDoc block ========= -->
766 <p class="short-description">create thumbnails for the requested width</p>
767 <p class="description"><p>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.</p></p>
768         <ul class="tags">
769                                 <li><span class="field">access:</span> public</li>
770                         </ul>
771         
772         <div class="method-signature">
773                 <span class="method-result">boolean</span>
774                 <span class="method-name">
775                         create_thumbnail
776                 </span>
777                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$orig_image</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$thumb_image</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$width</span>)
778                         </div>
779         
780                         <ul class="parameters">
781                                         <li>
782                                 <span class="var-type">string</span>
783                                 <span class="var-name">$orig_image</span>                       </li>
784                                         <li>
785                                 <span class="var-type">string</span>
786                                 <span class="var-name">$thumb_image</span>                      </li>
787                                         <li>
788                                 <span class="var-type">integer</span>
789                                 <span class="var-name">$width</span>                    </li>
790                                 </ul>
791                 
792                         
793         </div>
794 <a name="methoddelTag" id="delTag"><!-- --></a>
795 <div class="evenrow">
796         
797         <div class="method-header">
798                 <img src="../media/images/Method.png" />
799                 <span class="method-title">delTag</span> (line <span class="line-number">954</span>)
800         </div> 
801         
802         <!-- ========== Info from phpDoc block ========= -->
803 <p class="short-description">remove tag to users session variable</p>
804 <p class="description"><p>this function removes the specified tag from  users current tag selection</p></p>
805         <ul class="tags">
806                                 <li><span class="field">access:</span> public</li>
807                         </ul>
808         
809         <div class="method-signature">
810                 <span class="method-result">string</span>
811                 <span class="method-name">
812                         delTag
813                 </span>
814                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$tag</span>)
815                         </div>
816         
817                         <ul class="parameters">
818                                         <li>
819                                 <span class="var-type">string</span>
820                                 <span class="var-name">$tag</span>                      </li>
821                                 </ul>
822                 
823                         
824         </div>
825 <a name="methodgen_thumb" id="gen_thumb"><!-- --></a>
826 <div class="oddrow">
827         
828         <div class="method-header">
829                 <img src="../media/images/Method.png" />
830                 <span class="method-title">gen_thumb</span> (line <span class="line-number">1846</span>)
831         </div> 
832         
833         <!-- ========== Info from phpDoc block ========= -->
834 <p class="short-description">Generates a thumbnail from photo idx</p>
835 <p class="description"><p>This function will generate JPEG thumbnails from provided F-Spot photo  indizes.</p><p><ol><li>Check if all thumbnail generations (width) are already in place and
836     readable</li><li>Check if the md5sum of the original file has changed</li><li>Generate the thumbnails if needed</li></ol></p></p>
837         <ul class="tags">
838                                 <li><span class="field">access:</span> public</li>
839                         </ul>
840         
841         <div class="method-signature">
842                 <span class="method-result">void</span>
843                 <span class="method-name">
844                         gen_thumb
845                 </span>
846                                         ([<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$force</span> = <span class="var-default">0</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwrite</span> = <span class="var-default">false</span>])
847                         </div>
848         
849                         <ul class="parameters">
850                                         <li>
851                                 <span class="var-type">integer</span>
852                                 <span class="var-name">$idx</span>                      </li>
853                                         <li>
854                                 <span class="var-type">integer</span>
855                                 <span class="var-name">$force</span>                    </li>
856                                         <li>
857                                 <span class="var-type">boolean</span>
858                                 <span class="var-name">$overwrite</span>                        </li>
859                                 </ul>
860                 
861                         
862         </div>
863 <a name="methodgetAvailableTags" id="getAvailableTags"><!-- --></a>
864 <div class="evenrow">
865         
866         <div class="method-header">
867                 <img src="../media/images/Method.png" />
868                 <span class="method-title">getAvailableTags</span> (line <span class="line-number">791</span>)
869         </div> 
870         
871         <!-- ========== Info from phpDoc block ========= -->
872 <p class="short-description">all available tags and tag cloud</p>
873 <p class="description"><p>this function outputs all available tags (time ordered)  and in addition output them as tag cloud (tags which have  many photos will appears more then others)</p></p>
874         <ul class="tags">
875                                 <li><span class="field">access:</span> public</li>
876                         </ul>
877         
878         <div class="method-signature">
879                 <span class="method-result">void</span>
880                 <span class="method-name">
881                         getAvailableTags
882                 </span>
883                                 ()
884                         </div>
885         
886                 
887                         
888         </div>
889 <a name="methodgetCurrentPhoto" id="getCurrentPhoto"><!-- --></a>
890 <div class="oddrow">
891         
892         <div class="method-header">
893                 <img src="../media/images/Method.png" />
894                 <span class="method-title">getCurrentPhoto</span> (line <span class="line-number">2620</span>)
895         </div> 
896         
897         <!-- ========== Info from phpDoc block ========= -->
898 <p class="short-description">return the current photo</p>
899         <ul class="tags">
900                                 <li><span class="field">access:</span> public</li>
901                         </ul>
902         
903         <div class="method-signature">
904                 <span class="method-result">void</span>
905                 <span class="method-name">
906                         getCurrentPhoto
907                 </span>
908                                 ()
909                         </div>
910         
911                 
912                         
913         </div>
914 <a name="methodgetExport" id="getExport"><!-- --></a>
915 <div class="evenrow">
916         
917         <div class="method-header">
918                 <img src="../media/images/Method.png" />
919                 <span class="method-title">getExport</span> (line <span class="line-number">2475</span>)
920         </div> 
921         
922         <!-- ========== Info from phpDoc block ========= -->
923 <p class="short-description">output export page</p>
924         <ul class="tags">
925                                 <li><span class="field">access:</span> public</li>
926                         </ul>
927         
928         <div class="method-signature">
929                 <span class="method-result">void</span>
930                 <span class="method-name">
931                         getExport
932                 </span>
933                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$mode</span>)
934                         </div>
935         
936                         <ul class="parameters">
937                                         <li>
938                                 <span class="var-type">string</span>
939                                 <span class="var-name">$mode</span>                     </li>
940                                 </ul>
941                 
942                         
943         </div>
944 <a name="methodgetFspotDBVersion" id="getFspotDBVersion"><!-- --></a>
945 <div class="oddrow">
946         
947         <div class="method-header">
948                 <img src="../media/images/Method.png" />
949                 <span class="method-title">getFspotDBVersion</span> (line <span class="line-number">3059</span>)
950         </div> 
951         
952         <!-- ========== Info from phpDoc block ========= -->
953 <p class="short-description">retrive F-Spot database version</p>
954 <p class="description"><p>this function will return the F-Spot database version number  It is stored within the sqlite3 database in the table meta</p></p>
955         <ul class="tags">
956                                 <li><span class="field">access:</span> public</li>
957                         </ul>
958         
959         <div class="method-signature">
960                 <span class="method-result">string|null</span>
961                 <span class="method-name">
962                         getFspotDBVersion
963                 </span>
964                                 ()
965                         </div>
966         
967                 
968                         
969         </div>
970 <a name="methodgetMD5" id="getMD5"><!-- --></a>
971 <div class="evenrow">
972         
973         <div class="method-header">
974                 <img src="../media/images/Method.png" />
975                 <span class="method-title">getMD5</span> (line <span class="line-number">1948</span>)
976         </div> 
977         
978         <!-- ========== Info from phpDoc block ========= -->
979 <p class="short-description">returns stored md5 sum for a specific photo</p>
980 <p class="description"><p>this function queries the phpfspot database for a  stored MD5 checksum of the specified photo</p></p>
981         <ul class="tags">
982                                 <li><span class="field">access:</span> public</li>
983                         </ul>
984         
985         <div class="method-signature">
986                 <span class="method-result">string|null</span>
987                 <span class="method-name">
988                         getMD5
989                 </span>
990                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
991                         </div>
992         
993                         <ul class="parameters">
994                                         <li>
995                                 <span class="var-type">integer</span>
996                                 <span class="var-name">$idx</span>                      </li>
997                                 </ul>
998                 
999                         
1000         </div>
1001 <a name="methodgetNextSlideShowImage" id="getNextSlideShowImage"><!-- --></a>
1002 <div class="oddrow">
1003         
1004         <div class="method-header">
1005                 <img src="../media/images/Method.png" />
1006                 <span class="method-title">getNextSlideShowImage</span> (line <span class="line-number">2740</span>)
1007         </div> 
1008         
1009         <!-- ========== Info from phpDoc block ========= -->
1010 <p class="short-description">return the next to be shown slide show image</p>
1011 <p class="description"><p>this function returns the URL of the next image  in the slideshow sequence.</p></p>
1012         <ul class="tags">
1013                                 <li><span class="field">access:</span> public</li>
1014                         </ul>
1015         
1016         <div class="method-signature">
1017                 <span class="method-result">string</span>
1018                 <span class="method-name">
1019                         getNextSlideShowImage
1020                 </span>
1021                                 ()
1022                         </div>
1023         
1024                 
1025                         
1026         </div>
1027 <a name="methodgetPhotoName" id="getPhotoName"><!-- --></a>
1028 <div class="evenrow">
1029         
1030         <div class="method-header">
1031                 <img src="../media/images/Method.png" />
1032                 <span class="method-title">getPhotoName</span> (line <span class="line-number">522</span>)
1033         </div> 
1034         
1035         <!-- ========== Info from phpDoc block ========= -->
1036 <p class="short-description">returns aligned photo names</p>
1037 <p class="description"><p>this function returns aligned (length) names for  an specific photo. If the length of the name exceeds  $limit the name will be shrinked (...)</p></p>
1038         <ul class="tags">
1039                                 <li><span class="field">access:</span> public</li>
1040                         </ul>
1041         
1042         <div class="method-signature">
1043                 <span class="method-result">string|null</span>
1044                 <span class="method-name">
1045                         getPhotoName
1046                 </span>
1047                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">0</span>])
1048                         </div>
1049         
1050                         <ul class="parameters">
1051                                         <li>
1052                                 <span class="var-type">integer</span>
1053                                 <span class="var-name">$idx</span>                      </li>
1054                                         <li>
1055                                 <span class="var-type">integer</span>
1056                                 <span class="var-name">$limit</span>                    </li>
1057                                 </ul>
1058                 
1059                         
1060         </div>
1061 <a name="methodgetPhotoSelection" id="getPhotoSelection"><!-- --></a>
1062 <div class="oddrow">
1063         
1064         <div class="method-header">
1065                 <img src="../media/images/Method.png" />
1066                 <span class="method-title">getPhotoSelection</span> (line <span class="line-number">1108</span>)
1067         </div> 
1068         
1069         <!-- ========== Info from phpDoc block ========= -->
1070 <p class="short-description">return all photo according selection</p>
1071 <p class="description"><p>this function returns all photos based on  the tag-selection, tag- or date-search.  the tag-search also has to take care of AND  and OR conjunctions</p></p>
1072         <ul class="tags">
1073                                 <li><span class="field">access:</span> public</li>
1074                         </ul>
1075         
1076         <div class="method-signature">
1077                 <span class="method-result">array</span>
1078                 <span class="method-name">
1079                         getPhotoSelection
1080                 </span>
1081                                 ()
1082                         </div>
1083         
1084                 
1085                         
1086         </div>
1087 <a name="methodgetPrevSlideShowImage" id="getPrevSlideShowImage"><!-- --></a>
1088 <div class="evenrow">
1089         
1090         <div class="method-header">
1091                 <img src="../media/images/Method.png" />
1092                 <span class="method-title">getPrevSlideShowImage</span> (line <span class="line-number">2764</span>)
1093         </div> 
1094         
1095         <!-- ========== Info from phpDoc block ========= -->
1096 <p class="short-description">return the previous to be shown slide show image</p>
1097 <p class="description"><p>this function returns the URL of the previous image  in the slideshow sequence.</p></p>
1098         <ul class="tags">
1099                                 <li><span class="field">access:</span> public</li>
1100                         </ul>
1101         
1102         <div class="method-signature">
1103                 <span class="method-result">string</span>
1104                 <span class="method-name">
1105                         getPrevSlideShowImage
1106                 </span>
1107                                 ()
1108                         </div>
1109         
1110                 
1111                         
1112         </div>
1113 <a name="methodgetRSSFeed" id="getRSSFeed"><!-- --></a>
1114 <div class="oddrow">
1115         
1116         <div class="method-header">
1117                 <img src="../media/images/Method.png" />
1118                 <span class="method-title">getRSSFeed</span> (line <span class="line-number">2522</span>)
1119         </div> 
1120         
1121         <!-- ========== Info from phpDoc block ========= -->
1122 <p class="short-description">output RSS feed</p>
1123         <ul class="tags">
1124                                 <li><span class="field">access:</span> public</li>
1125                         </ul>
1126         
1127         <div class="method-signature">
1128                 <span class="method-result">void</span>
1129                 <span class="method-name">
1130                         getRSSFeed
1131                 </span>
1132                                 ()
1133                         </div>
1134         
1135                 
1136                         
1137         </div>
1138 <a name="methodgetSelectedTags" id="getSelectedTags"><!-- --></a>
1139 <div class="evenrow">
1140         
1141         <div class="method-header">
1142                 <img src="../media/images/Method.png" />
1143                 <span class="method-title">getSelectedTags</span> (line <span class="line-number">877</span>)
1144         </div> 
1145         
1146         <!-- ========== Info from phpDoc block ========= -->
1147 <p class="short-description">output all selected tags</p>
1148 <p class="description"><p>this function output all tags which have been selected  by the user. the selected tags are stored in the  session-variable $_SESSION['selected_tags']</p></p>
1149         <ul class="tags">
1150                                 <li><span class="field">access:</span> public</li>
1151                         </ul>
1152         
1153         <div class="method-signature">
1154                 <span class="method-result">string</span>
1155                 <span class="method-name">
1156                         getSelectedTags
1157                 </span>
1158                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'link'</span>])
1159                         </div>
1160         
1161                         <ul class="parameters">
1162                                         <li>
1163                                 <span class="var-type"></span>
1164                                 <span class="var-name">$type</span>                     </li>
1165                                 </ul>
1166                 
1167                         
1168         </div>
1169 <a name="methodget_calendar_matrix" id="get_calendar_matrix"><!-- --></a>
1170 <div class="oddrow">
1171         
1172         <div class="method-header">
1173                 <img src="../media/images/Method.png" />
1174                 <span class="method-title">get_calendar_matrix</span> (line <span class="line-number">2396</span>)
1175         </div> 
1176         
1177         <!-- ========== Info from phpDoc block ========= -->
1178 <p class="short-description">output calendar matrix</p>
1179         <ul class="tags">
1180                                 <li><span class="field">access:</span> public</li>
1181                         </ul>
1182         
1183         <div class="method-signature">
1184                 <span class="method-result">void</span>
1185                 <span class="method-name">
1186                         get_calendar_matrix
1187                 </span>
1188                                         ([<span class="var-type">integer</span>&nbsp;<span class="var-name">$year</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$month</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$day</span> = <span class="var-default">0</span>])
1189                         </div>
1190         
1191                         <ul class="parameters">
1192                                         <li>
1193                                 <span class="var-type">integer</span>
1194                                 <span class="var-name">$year</span>                     </li>
1195                                         <li>
1196                                 <span class="var-type">integer</span>
1197                                 <span class="var-name">$month</span>                    </li>
1198                                         <li>
1199                                 <span class="var-type">integer</span>
1200                                 <span class="var-name">$day</span>                      </li>
1201                                 </ul>
1202                 
1203                         
1204         </div>
1205 <a name="methodget_meta_informations" id="get_meta_informations"><!-- --></a>
1206 <div class="evenrow">
1207         
1208         <div class="method-header">
1209                 <img src="../media/images/Method.png" />
1210                 <span class="method-title">get_meta_informations</span> (line <span class="line-number">1805</span>)
1211         </div> 
1212         
1213         <!-- ========== Info from phpDoc block ========= -->
1214 <p class="short-description">return all exif meta data from the file</p>
1215         <ul class="tags">
1216                                 <li><span class="field">access:</span> public</li>
1217                         </ul>
1218         
1219         <div class="method-signature">
1220                 <span class="method-result">array</span>
1221                 <span class="method-name">
1222                         get_meta_informations
1223                 </span>
1224                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
1225                         </div>
1226         
1227                         <ul class="parameters">
1228                                         <li>
1229                                 <span class="var-type">string</span>
1230                                 <span class="var-name">$file</span>                     </li>
1231                                 </ul>
1232                 
1233                         
1234         </div>
1235 <a name="methodget_mime_info" id="get_mime_info"><!-- --></a>
1236 <div class="oddrow">
1237         
1238         <div class="method-header">
1239                 <img src="../media/images/Method.png" />
1240                 <span class="method-title">get_mime_info</span> (line <span class="line-number">3251</span>)
1241         </div> 
1242         
1243         <!-- ========== Info from phpDoc block ========= -->
1244 <p class="short-description">return mime info</p>
1245 <p class="description"><p>this function tries to find out the correct mime-type  for the provided file.</p></p>
1246         <ul class="tags">
1247                                 <li><span class="field">access:</span> public</li>
1248                         </ul>
1249         
1250         <div class="method-signature">
1251                 <span class="method-result">string</span>
1252                 <span class="method-name">
1253                         get_mime_info
1254                 </span>
1255                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
1256                         </div>
1257         
1258                         <ul class="parameters">
1259                                         <li>
1260                                 <span class="var-type">string</span>
1261                                 <span class="var-name">$file</span>                     </li>
1262                                 </ul>
1263                 
1264                         
1265         </div>
1266 <a name="methodget_num_photos" id="get_num_photos"><!-- --></a>
1267 <div class="evenrow">
1268         
1269         <div class="method-header">
1270                 <img src="../media/images/Method.png" />
1271                 <span class="method-title">get_num_photos</span> (line <span class="line-number">2988</span>)
1272         </div> 
1273         
1274         <!-- ========== Info from phpDoc block ========= -->
1275 <p class="short-description">returns the number of photos which are tagged with $tag_id</p>
1276         <ul class="tags">
1277                                 <li><span class="field">access:</span> public</li>
1278                         </ul>
1279         
1280         <div class="method-signature">
1281                 <span class="method-result">integer</span>
1282                 <span class="method-name">
1283                         get_num_photos
1284                 </span>
1285                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$tag_id</span>)
1286                         </div>
1287         
1288                         <ul class="parameters">
1289                                         <li>
1290                                 <span class="var-type">integer</span>
1291                                 <span class="var-name">$tag_id</span>                   </li>
1292                                 </ul>
1293                 
1294                         
1295         </div>
1296 <a name="methodget_photo_details" id="get_photo_details"><!-- --></a>
1297 <div class="oddrow">
1298         
1299         <div class="method-header">
1300                 <img src="../media/images/Method.png" />
1301                 <span class="method-title">get_photo_details</span> (line <span class="line-number">454</span>)
1302         </div> 
1303         
1304         <!-- ========== Info from phpDoc block ========= -->
1305 <p class="short-description">extract all photo details</p>
1306 <p class="description"><p>retrieve all available details from f-spot's  database and return them as object</p></p>
1307         <ul class="tags">
1308                                 <li><span class="field">access:</span> public</li>
1309                         </ul>
1310         
1311         <div class="method-signature">
1312                 <span class="method-result">object|null</span>
1313                 <span class="method-name">
1314                         get_photo_details
1315                 </span>
1316                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
1317                         </div>
1318         
1319                         <ul class="parameters">
1320                                         <li>
1321                                 <span class="var-type">integer</span>
1322                                 <span class="var-name">$idx</span>                      </li>
1323                                 </ul>
1324                 
1325                         
1326         </div>
1327 <a name="methodget_photo_rating" id="get_photo_rating"><!-- --></a>
1328 <div class="evenrow">
1329         
1330         <div class="method-header">
1331                 <img src="../media/images/Method.png" />
1332                 <span class="method-title">get_photo_rating</span> (line <span class="line-number">546</span>)
1333         </div> 
1334         
1335         <!-- ========== Info from phpDoc block ========= -->
1336 <p class="short-description">get photo rating level</p>
1337 <p class="description"><p>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.</p></p>
1338         <ul class="tags">
1339                                 <li><span class="field">access:</span> public</li>
1340                         </ul>
1341         
1342         <div class="method-signature">
1343                 <span class="method-result">integer</span>
1344                 <span class="method-name">
1345                         get_photo_rating
1346                 </span>
1347                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
1348                         </div>
1349         
1350                         <ul class="parameters">
1351                                         <li>
1352                                 <span class="var-type">integer</span>
1353                                 <span class="var-name">$idx</span><span class="var-description">: idx</span>                    </li>
1354                                 </ul>
1355                 
1356                         
1357         </div>
1358 <a name="methodget_random_photo" id="get_random_photo"><!-- --></a>
1359 <div class="oddrow">
1360         
1361         <div class="method-header">
1362                 <img src="../media/images/Method.png" />
1363                 <span class="method-title">get_random_photo</span> (line <span class="line-number">2799</span>)
1364         </div> 
1365         
1366         <!-- ========== Info from phpDoc block ========= -->
1367 <p class="short-description">get random photo</p>
1368 <p class="description"><p>this function will get all photos from the fspot  database and randomly return ONE entry</p><p>saddly there is yet no sqlite3 function which returns  the bulk result in array, so we have to fill up our  own here.</p></p>
1369         <ul class="tags">
1370                                 <li><span class="field">access:</span> public</li>
1371                         </ul>
1372         
1373         <div class="method-signature">
1374                 <span class="method-result">array</span>
1375                 <span class="method-name">
1376                         get_random_photo
1377                 </span>
1378                                 ()
1379                         </div>
1380         
1381                 
1382                         
1383         </div>
1384 <a name="methodget_random_tag_photo" id="get_random_tag_photo"><!-- --></a>
1385 <div class="evenrow">
1386         
1387         <div class="method-header">
1388                 <img src="../media/images/Method.png" />
1389                 <span class="method-title">get_random_tag_photo</span> (line <span class="line-number">2842</span>)
1390         </div> 
1391         
1392         <!-- ========== Info from phpDoc block ========= -->
1393 <p class="short-description">get random photo tag photo</p>
1394 <p class="description"><p>this function will get all photos tagged with the requested  tag from the fspot database and randomly return ONE entry</p><p>saddly there is yet no sqlite3 function which returns  the bulk result in array, so we have to fill up our  own here.</p></p>
1395         <ul class="tags">
1396                                 <li><span class="field">access:</span> public</li>
1397                         </ul>
1398         
1399         <div class="method-signature">
1400                 <span class="method-result">array</span>
1401                 <span class="method-name">
1402                         get_random_tag_photo
1403                 </span>
1404                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$tagidx</span>)
1405                         </div>
1406         
1407                         <ul class="parameters">
1408                                         <li>
1409                                 <span class="var-type"></span>
1410                                 <span class="var-name">$tagidx</span>                   </li>
1411                                 </ul>
1412                 
1413                         
1414         </div>
1415 <a name="methodget_rate_search" id="get_rate_search"><!-- --></a>
1416 <div class="oddrow">
1417         
1418         <div class="method-header">
1419                 <img src="../media/images/Method.png" />
1420                 <span class="method-title">get_rate_search</span> (line <span class="line-number">564</span>)
1421         </div> 
1422         
1423         <!-- ========== Info from phpDoc block ========= -->
1424 <p class="short-description">get rate-search bars</p>
1425 <p class="description"><p>this function will return the rating-bars for the  search field.</p></p>
1426         <ul class="tags">
1427                                 <li><span class="field">access:</span> public</li>
1428                         </ul>
1429         
1430         <div class="method-signature">
1431                 <span class="method-result">string</span>
1432                 <span class="method-name">
1433                         get_rate_search
1434                 </span>
1435                                 ()
1436                         </div>
1437         
1438                 
1439                         
1440         </div>
1441 <a name="methodget_tag_name" id="get_tag_name"><!-- --></a>
1442 <div class="evenrow">
1443         
1444         <div class="method-header">
1445                 <img src="../media/images/Method.png" />
1446                 <span class="method-title">get_tag_name</span> (line <span class="line-number">3278</span>)
1447         </div> 
1448         
1449         <!-- ========== Info from phpDoc block ========= -->
1450 <p class="short-description">return tag-name by tag-idx</p>
1451 <p class="description"><p>this function returns the tag-name for the requested  tag specified by tag-idx.</p></p>
1452         <ul class="tags">
1453                                 <li><span class="field">access:</span> public</li>
1454                         </ul>
1455         
1456         <div class="method-signature">
1457                 <span class="method-result">string</span>
1458                 <span class="method-name">
1459                         get_tag_name
1460                 </span>
1461                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
1462                         </div>
1463         
1464                         <ul class="parameters">
1465                                         <li>
1466                                 <span class="var-type">integer</span>
1467                                 <span class="var-name">$idx</span>                      </li>
1468                                 </ul>
1469                 
1470                         
1471         </div>
1472 <a name="methodget_thumb_path" id="get_thumb_path"><!-- --></a>
1473 <div class="oddrow">
1474         
1475         <div class="method-header">
1476                 <img src="../media/images/Method.png" />
1477                 <span class="method-title">get_thumb_path</span> (line <span class="line-number">2938</span>)
1478         </div> 
1479         
1480         <!-- ========== Info from phpDoc block ========= -->
1481 <p class="short-description">returns the full path to a thumbnail</p>
1482         <ul class="tags">
1483                                 <li><span class="field">access:</span> public</li>
1484                         </ul>
1485         
1486         <div class="method-signature">
1487                 <span class="method-result">string</span>
1488                 <span class="method-name">
1489                         get_thumb_path
1490                 </span>
1491                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$width</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$photo</span>)
1492                         </div>
1493         
1494                         <ul class="parameters">
1495                                         <li>
1496                                 <span class="var-type">integer</span>
1497                                 <span class="var-name">$width</span>                    </li>
1498                                         <li>
1499                                 <span class="var-type">integer</span>
1500                                 <span class="var-name">$photo</span>                    </li>
1501                                 </ul>
1502                 
1503                         
1504         </div>
1505 <a name="methodget_xml_tag_list" id="get_xml_tag_list"><!-- --></a>
1506 <div class="evenrow">
1507         
1508         <div class="method-header">
1509                 <img src="../media/images/Method.png" />
1510                 <span class="method-title">get_xml_tag_list</span> (line <span class="line-number">986</span>)
1511         </div> 
1512         
1513         <!-- ========== Info from phpDoc block ========= -->
1514 <p class="short-description">returns the value for the autocomplete tag-search</p>
1515         <ul class="tags">
1516                                 <li><span class="field">access:</span> public</li>
1517                         </ul>
1518         
1519         <div class="method-signature">
1520                 <span class="method-result">string</span>
1521                 <span class="method-name">
1522                         get_xml_tag_list
1523                 </span>
1524                                 ()
1525                         </div>
1526         
1527                 
1528                         
1529         </div>
1530 <a name="methodisValidDate" id="isValidDate"><!-- --></a>
1531 <div class="oddrow">
1532         
1533         <div class="method-header">
1534                 <img src="../media/images/Method.png" />
1535                 <span class="method-title">isValidDate</span> (line <span class="line-number">2890</span>)
1536         </div> 
1537         
1538         <!-- ========== Info from phpDoc block ========= -->
1539 <p class="short-description">validates provided date</p>
1540 <p class="description"><p>this function validates if the provided date  contains a valid date and will return true  if it is.</p></p>
1541         <ul class="tags">
1542                                 <li><span class="field">access:</span> public</li>
1543                         </ul>
1544         
1545         <div class="method-signature">
1546                 <span class="method-result">boolean</span>
1547                 <span class="method-name">
1548                         isValidDate
1549                 </span>
1550                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$date_str</span>)
1551                         </div>
1552         
1553                         <ul class="parameters">
1554                                         <li>
1555                                 <span class="var-type">string</span>
1556                                 <span class="var-name">$date_str</span>                 </li>
1557                                 </ul>
1558                 
1559                         
1560         </div>
1561 <a name="methodparse_uri" id="parse_uri"><!-- --></a>
1562 <div class="evenrow">
1563         
1564         <div class="method-header">
1565                 <img src="../media/images/Method.png" />
1566                 <span class="method-title">parse_uri</span> (line <span class="line-number">3079</span>)
1567         </div> 
1568         
1569         <!-- ========== Info from phpDoc block ========= -->
1570 <p class="short-description">parse the provided URI and will returned the requested chunk</p>
1571         <ul class="tags">
1572                                 <li><span class="field">access:</span> public</li>
1573                         </ul>
1574         
1575         <div class="method-signature">
1576                 <span class="method-result">string</span>
1577                 <span class="method-name">
1578                         parse_uri
1579                 </span>
1580                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$uri</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$mode</span>)
1581                         </div>
1582         
1583                         <ul class="parameters">
1584                                         <li>
1585                                 <span class="var-type">string</span>
1586                                 <span class="var-name">$uri</span>                      </li>
1587                                         <li>
1588                                 <span class="var-type">string</span>
1589                                 <span class="var-name">$mode</span>                     </li>
1590                                 </ul>
1591                 
1592                         
1593         </div>
1594 <a name="methodresetDateSearch" id="resetDateSearch"><!-- --></a>
1595 <div class="oddrow">
1596         
1597         <div class="method-header">
1598                 <img src="../media/images/Method.png" />
1599                 <span class="method-title">resetDateSearch</span> (line <span class="line-number">1076</span>)
1600         </div> 
1601         
1602         <!-- ========== Info from phpDoc block ========= -->
1603 <p class="short-description">reset date search</p>
1604 <p class="description"><p>if any date search has taken place, reset it now.</p></p>
1605         <ul class="tags">
1606                                 <li><span class="field">access:</span> public</li>
1607                         </ul>
1608         
1609         <div class="method-signature">
1610                 <span class="method-result">void</span>
1611                 <span class="method-name">
1612                         resetDateSearch
1613                 </span>
1614                                 ()
1615                         </div>
1616         
1617                 
1618                         
1619         </div>
1620 <a name="methodresetNameSearch" id="resetNameSearch"><!-- --></a>
1621 <div class="evenrow">
1622         
1623         <div class="method-header">
1624                 <img src="../media/images/Method.png" />
1625                 <span class="method-title">resetNameSearch</span> (line <span class="line-number">1064</span>)
1626         </div> 
1627         
1628         <!-- ========== Info from phpDoc block ========= -->
1629 <p class="short-description">reset name search</p>
1630 <p class="description"><p>if any name search has taken place, reset it now</p></p>
1631         <ul class="tags">
1632                                 <li><span class="field">access:</span> public</li>
1633                         </ul>
1634         
1635         <div class="method-signature">
1636                 <span class="method-result">void</span>
1637                 <span class="method-name">
1638                         resetNameSearch
1639                 </span>
1640                                 ()
1641                         </div>
1642         
1643                 
1644                         
1645         </div>
1646 <a name="methodresetPhotoView" id="resetPhotoView"><!-- --></a>
1647 <div class="oddrow">
1648         
1649         <div class="method-header">
1650                 <img src="../media/images/Method.png" />
1651                 <span class="method-title">resetPhotoView</span> (line <span class="line-number">1040</span>)
1652         </div> 
1653         
1654         <!-- ========== Info from phpDoc block ========= -->
1655 <p class="short-description">reset single photo</p>
1656 <p class="description"><p>if a specific photo was requested (external link)  unset the session variable now</p></p>
1657         <ul class="tags">
1658                                 <li><span class="field">access:</span> public</li>
1659                         </ul>
1660         
1661         <div class="method-signature">
1662                 <span class="method-result">void</span>
1663                 <span class="method-name">
1664                         resetPhotoView
1665                 </span>
1666                                 ()
1667                         </div>
1668         
1669                 
1670                         
1671         </div>
1672 <a name="methodresetRateSearch" id="resetRateSearch"><!-- --></a>
1673 <div class="evenrow">
1674         
1675         <div class="method-header">
1676                 <img src="../media/images/Method.png" />
1677                 <span class="method-title">resetRateSearch</span> (line <span class="line-number">1090</span>)
1678         </div> 
1679         
1680         <!-- ========== Info from phpDoc block ========= -->
1681 <p class="short-description">reset rate search</p>
1682 <p class="description"><p>if any rate search has taken place, reset it now.</p></p>
1683         <ul class="tags">
1684                                 <li><span class="field">access:</span> public</li>
1685                         </ul>
1686         
1687         <div class="method-signature">
1688                 <span class="method-result">void</span>
1689                 <span class="method-name">
1690                         resetRateSearch
1691                 </span>
1692                                 ()
1693                         </div>
1694         
1695                 
1696                         
1697         </div>
1698 <a name="methodresetSlideShow" id="resetSlideShow"><!-- --></a>
1699 <div class="oddrow">
1700         
1701         <div class="method-header">
1702                 <img src="../media/images/Method.png" />
1703                 <span class="method-title">resetSlideShow</span> (line <span class="line-number">2781</span>)
1704         </div> 
1705         
1706         <!-- ========== Info from phpDoc block ========= -->
1707         <ul class="tags">
1708                                 <li><span class="field">access:</span> public</li>
1709                         </ul>
1710         
1711         <div class="method-signature">
1712                 <span class="method-result">void</span>
1713                 <span class="method-name">
1714                         resetSlideShow
1715                 </span>
1716                                 ()
1717                         </div>
1718         
1719                 
1720                         
1721         </div>
1722 <a name="methodresetTags" id="resetTags"><!-- --></a>
1723 <div class="evenrow">
1724         
1725         <div class="method-header">
1726                 <img src="../media/images/Method.png" />
1727                 <span class="method-title">resetTags</span> (line <span class="line-number">975</span>)
1728         </div> 
1729         
1730         <!-- ========== Info from phpDoc block ========= -->
1731 <p class="short-description">reset tag selection</p>
1732 <p class="description"><p>if there is any tag selection, it will be  deleted now</p></p>
1733         <ul class="tags">
1734                                 <li><span class="field">access:</span> public</li>
1735                         </ul>
1736         
1737         <div class="method-signature">
1738                 <span class="method-result">void</span>
1739                 <span class="method-name">
1740                         resetTags
1741                 </span>
1742                                 ()
1743                         </div>
1744         
1745                 
1746                         
1747         </div>
1748 <a name="methodresetTagSearch" id="resetTagSearch"><!-- --></a>
1749 <div class="oddrow">
1750         
1751         <div class="method-header">
1752                 <img src="../media/images/Method.png" />
1753                 <span class="method-title">resetTagSearch</span> (line <span class="line-number">1052</span>)
1754         </div> 
1755         
1756         <!-- ========== Info from phpDoc block ========= -->
1757 <p class="short-description">reset tag search</p>
1758 <p class="description"><p>if any tag search has taken place, reset it now</p></p>
1759         <ul class="tags">
1760                                 <li><span class="field">access:</span> public</li>
1761                         </ul>
1762         
1763         <div class="method-signature">
1764                 <span class="method-result">void</span>
1765                 <span class="method-name">
1766                         resetTagSearch
1767                 </span>
1768                                 ()
1769                         </div>
1770         
1771                 
1772                         
1773         </div>
1774 <a name="methodsetTagCondition" id="setTagCondition"><!-- --></a>
1775 <div class="evenrow">
1776         
1777         <div class="method-header">
1778                 <img src="../media/images/Method.png" />
1779                 <span class="method-title">setTagCondition</span> (line <span class="line-number">1986</span>)
1780         </div> 
1781         
1782         <!-- ========== Info from phpDoc block ========= -->
1783 <p class="short-description">store current tag condition</p>
1784 <p class="description"><p>this function stores the current tag condition  (AND or OR) in the users session variables</p></p>
1785         <ul class="tags">
1786                                 <li><span class="field">access:</span> public</li>
1787                         </ul>
1788         
1789         <div class="method-signature">
1790                 <span class="method-result">string</span>
1791                 <span class="method-name">
1792                         setTagCondition
1793                 </span>
1794                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$mode</span>)
1795                         </div>
1796         
1797                         <ul class="parameters">
1798                                         <li>
1799                                 <span class="var-type">string</span>
1800                                 <span class="var-name">$mode</span>                     </li>
1801                                 </ul>
1802                 
1803                         
1804         </div>
1805 <a name="methodshow" id="show"><!-- --></a>
1806 <div class="oddrow">
1807         
1808         <div class="method-header">
1809                 <img src="../media/images/Method.png" />
1810                 <span class="method-title">show</span> (line <span class="line-number">257</span>)
1811         </div> 
1812         
1813         <!-- ========== Info from phpDoc block ========= -->
1814 <p class="short-description">show - generate html output</p>
1815 <p class="description"><p>this function can be called after the constructor has  prepared everyhing. it will load the index.tpl smarty  template. if necessary it will registere pre-selects  (photo index, photo, tag search, date search) into  users session.</p></p>
1816         <ul class="tags">
1817                                 <li><span class="field">access:</span> public</li>
1818                         </ul>
1819         
1820         <div class="method-signature">
1821                 <span class="method-result">void</span>
1822                 <span class="method-name">
1823                         show
1824                 </span>
1825                                 ()
1826                         </div>
1827         
1828                 
1829                         
1830         </div>
1831 <a name="methodshowCredits" id="showCredits"><!-- --></a>
1832 <div class="evenrow">
1833         
1834         <div class="method-header">
1835                 <img src="../media/images/Method.png" />
1836                 <span class="method-title">showCredits</span> (line <span class="line-number">1550</span>)
1837         </div> 
1838         
1839         <!-- ========== Info from phpDoc block ========= -->
1840 <p class="short-description">show credit template</p>
1841         <ul class="tags">
1842                                 <li><span class="field">access:</span> public</li>
1843                         </ul>
1844         
1845         <div class="method-signature">
1846                 <span class="method-result">void</span>
1847                 <span class="method-name">
1848                         showCredits
1849                 </span>
1850                                 ()
1851                         </div>
1852         
1853                 
1854                         
1855         </div>
1856 <a name="methodshowPhoto" id="showPhoto"><!-- --></a>
1857 <div class="oddrow">
1858         
1859         <div class="method-header">
1860                 <img src="../media/images/Method.png" />
1861                 <span class="method-title">showPhoto</span> (line <span class="line-number">646</span>)
1862         </div> 
1863         
1864         <!-- ========== Info from phpDoc block ========= -->
1865 <p class="short-description">control HTML ouput for a single photo</p>
1866 <p class="description"><p>this function provides all the necessary information  for the single photo template.</p></p>
1867         <ul class="tags">
1868                                 <li><span class="field">access:</span> public</li>
1869                         </ul>
1870         
1871         <div class="method-signature">
1872                 <span class="method-result">void</span>
1873                 <span class="method-name">
1874                         showPhoto
1875                 </span>
1876                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$photo</span>)
1877                         </div>
1878         
1879                         <ul class="parameters">
1880                                         <li>
1881                                 <span class="var-type">integer</span>
1882                                 <span class="var-name">$photo</span><span class="var-description">: photo</span>                        </li>
1883                                 </ul>
1884                 
1885                         
1886         </div>
1887 <a name="methodshowPhotoIndex" id="showPhotoIndex"><!-- --></a>
1888 <div class="evenrow">
1889         
1890         <div class="method-header">
1891                 <img src="../media/images/Method.png" />
1892                 <span class="method-title">showPhotoIndex</span> (line <span class="line-number">1337</span>)
1893         </div> 
1894         
1895         <!-- ========== Info from phpDoc block ========= -->
1896 <p class="short-description">control HTML ouput for photo index</p>
1897 <p class="description"><p>this function provides all the necessary information  for the photo index template.</p></p>
1898         <ul class="tags">
1899                                 <li><span class="field">access:</span> public</li>
1900                         </ul>
1901         
1902         <div class="method-signature">
1903                 <span class="method-result">string</span>
1904                 <span class="method-name">
1905                         showPhotoIndex
1906                 </span>
1907                                 ()
1908                         </div>
1909         
1910                 
1911                         
1912         </div>
1913 <a name="methodshowTextImage" id="showTextImage"><!-- --></a>
1914 <div class="oddrow">
1915         
1916         <div class="method-header">
1917                 <img src="../media/images/Method.png" />
1918                 <span class="method-title">showTextImage</span> (line <span class="line-number">2236</span>)
1919         </div> 
1920         
1921         <!-- ========== Info from phpDoc block ========= -->
1922 <p class="short-description">create on-the-fly images with text within</p>
1923         <ul class="tags">
1924                                 <li><span class="field">access:</span> public</li>
1925                         </ul>
1926         
1927         <div class="method-signature">
1928                 <span class="method-result">void</span>
1929                 <span class="method-name">
1930                         showTextImage
1931                 </span>
1932                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$txt</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$color</span> = <span class="var-default">000000</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$space</span> = <span class="var-default">4</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$font</span> = <span class="var-default">4</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$w</span> = <span class="var-default">300</span>])
1933                         </div>
1934         
1935                         <ul class="parameters">
1936                                         <li>
1937                                 <span class="var-type">string</span>
1938                                 <span class="var-name">$txt</span>                      </li>
1939                                         <li>
1940                                 <span class="var-type">string</span>
1941                                 <span class="var-name">$color</span>                    </li>
1942                                         <li>
1943                                 <span class="var-type">integer</span>
1944                                 <span class="var-name">$space</span>                    </li>
1945                                         <li>
1946                                 <span class="var-type">integer</span>
1947                                 <span class="var-name">$font</span>                     </li>
1948                                         <li>
1949                                 <span class="var-type">integer</span>
1950                                 <span class="var-name">$w</span>                        </li>
1951                                 </ul>
1952                 
1953                         
1954         </div>
1955 <a name="methodsmarty_sort_select_list" id="smarty_sort_select_list"><!-- --></a>
1956 <div class="evenrow">
1957         
1958         <div class="method-header">
1959                 <img src="../media/images/Method.png" />
1960                 <span class="method-title">smarty_sort_select_list</span> (line <span class="line-number">2672</span>)
1961         </div> 
1962         
1963         <!-- ========== Info from phpDoc block ========= -->
1964 <p class="short-description">returns a select-dropdown box to select photo index sort parameters</p>
1965         <ul class="tags">
1966                                 <li><span class="field">access:</span> public</li>
1967                         </ul>
1968         
1969         <div class="method-signature">
1970                 <span class="method-result">string</span>
1971                 <span class="method-name">
1972                         smarty_sort_select_list
1973                 </span>
1974                                         (<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$smarty</span>, <span class="var-type">smarty</span>&nbsp;<span class="var-name">$smarty</span>)
1975                         </div>
1976         
1977                         <ul class="parameters">
1978                                         <li>
1979                                 <span class="var-type">array</span>
1980                                 <span class="var-name">$params</span>                   </li>
1981                                         <li>
1982                                 <span class="var-type">smarty</span>
1983                                 <span class="var-name">$smarty</span>                   </li>
1984                                         <li>
1985                                 <span class="var-type"></span>
1986                                 <span class="var-name">&$smarty</span>                  </li>
1987                                 </ul>
1988                 
1989                         
1990         </div>
1991 <a name="methodstartSearch" id="startSearch"><!-- --></a>
1992 <div class="oddrow">
1993         
1994         <div class="method-header">
1995                 <img src="../media/images/Method.png" />
1996                 <span class="method-title">startSearch</span> (line <span class="line-number">2004</span>)
1997         </div> 
1998         
1999         <!-- ========== Info from phpDoc block ========= -->
2000 <p class="short-description">invoke tag &amp; date search</p>
2001 <p class="description"><p>this function will return all matching tags and store  them in the session variable selected_tags. furthermore  it also handles the date search.  getPhotoSelection() will then only return the matching  photos.</p></p>
2002         <ul class="tags">
2003                                 <li><span class="field">access:</span> public</li>
2004                         </ul>
2005         
2006         <div class="method-signature">
2007                 <span class="method-result">string</span>
2008                 <span class="method-name">
2009                         startSearch
2010                 </span>
2011                                 ()
2012                         </div>
2013         
2014                 
2015                         
2016         </div>
2017 <a name="methodtranslate_path" id="translate_path"><!-- --></a>
2018 <div class="evenrow">
2019         
2020         <div class="method-header">
2021                 <img src="../media/images/Method.png" />
2022                 <span class="method-title">translate_path</span> (line <span class="line-number">633</span>)
2023         </div> 
2024         
2025         <!-- ========== Info from phpDoc block ========= -->
2026 <p class="short-description">translate f-spoth photo path</p>
2027 <p class="description"><p>as the full-qualified path recorded in the f-spot database  is usally not the same as on the webserver, this function  will replace the path with that one specified in the cfg</p></p>
2028         <ul class="tags">
2029                                 <li><span class="field">access:</span> public</li>
2030                         </ul>
2031         
2032         <div class="method-signature">
2033                 <span class="method-result">string</span>
2034                 <span class="method-name">
2035                         translate_path
2036                 </span>
2037                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
2038                         </div>
2039         
2040                         <ul class="parameters">
2041                                         <li>
2042                                 <span class="var-type">string</span>
2043                                 <span class="var-name">$path</span>                     </li>
2044                                 </ul>
2045                 
2046                         
2047         </div>
2048 <a name="methodupdateSortOrder" id="updateSortOrder"><!-- --></a>
2049 <div class="oddrow">
2050         
2051         <div class="method-header">
2052                 <img src="../media/images/Method.png" />
2053                 <span class="method-title">updateSortOrder</span> (line <span class="line-number">2078</span>)
2054         </div> 
2055         
2056         <!-- ========== Info from phpDoc block ========= -->
2057 <p class="short-description">updates sort order in session variable</p>
2058 <p class="description"><p>this function is invoked by RPC and will sort the requested  sort order in the session variable.</p></p>
2059         <ul class="tags">
2060                                 <li><span class="field">access:</span> public</li>
2061                         </ul>
2062         
2063         <div class="method-signature">
2064                 <span class="method-result">string</span>
2065                 <span class="method-name">
2066                         updateSortOrder
2067                 </span>
2068                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$order</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$sort_order</span>)
2069                         </div>
2070         
2071                         <ul class="parameters">
2072                                         <li>
2073                                 <span class="var-type">string</span>
2074                                 <span class="var-name">$sort_order</span>                       </li>
2075                                         <li>
2076                                 <span class="var-type"></span>
2077                                 <span class="var-name">$order</span>                    </li>
2078                                 </ul>
2079                 
2080                         
2081         </div>
2082 <a name="methodwhatToDo" id="whatToDo"><!-- --></a>
2083 <div class="evenrow">
2084         
2085         <div class="method-header">
2086                 <img src="../media/images/Method.png" />
2087                 <span class="method-title">whatToDo</span> (line <span class="line-number">2637</span>)
2088         </div> 
2089         
2090         <!-- ========== Info from phpDoc block ========= -->
2091 <p class="short-description">tells the client browser what to do</p>
2092 <p class="description"><p>this function is getting called via AJAX by the  client browsers. it will tell them what they have  to do next. This is necessary for directly jumping  into photo index or single photo view when the are  requested with specific URLs</p></p>
2093         <ul class="tags">
2094                                 <li><span class="field">access:</span> public</li>
2095                         </ul>
2096         
2097         <div class="method-signature">
2098                 <span class="method-result">string</span>
2099                 <span class="method-name">
2100                         whatToDo
2101                 </span>
2102                                 ()
2103                         </div>
2104         
2105                 
2106                         
2107         </div>
2108 <a name="method_error" id="_error"><!-- --></a>
2109 <div class="oddrow">
2110         
2111         <div class="method-header">
2112                 <img src="../media/images/Method.png" />
2113                 <span class="method-title">_error</span> (line <span class="line-number">2342</span>)
2114         </div> 
2115         
2116         <!-- ========== Info from phpDoc block ========= -->
2117 <p class="short-description">output error text</p>
2118         <ul class="tags">
2119                                 <li><span class="field">access:</span> public</li>
2120                         </ul>
2121         
2122         <div class="method-signature">
2123                 <span class="method-result">void</span>
2124                 <span class="method-name">
2125                         _error
2126                 </span>
2127                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
2128                         </div>
2129         
2130                         <ul class="parameters">
2131                                         <li>
2132                                 <span class="var-type">string</span>
2133                                 <span class="var-name">$text</span>                     </li>
2134                                 </ul>
2135                 
2136                         
2137         </div>
2138                                                 
2139                 </div>
2140         </div>
2141
2142         
2143         <p class="notes" id="credit">
2144                 Documentation generated on Sun, 25 May 2008 10:46:25 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
2145         </p>
2146         </div></body>
2147 </html>