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