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