/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/ImageThumbnailWidget.html
ViewVC logotype

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/ImageThumbnailWidget.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (show annotations)
Sat Feb 22 20:56:28 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Changes since 1.1: +604 -932 lines
File MIME type: text/html
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)

1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:23:01 -0800' -->
6 <TITLE>Docs For Class ImageThumbnailWidget</TITLE>
7 <LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'>
8 </HEAD>
9 <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10 <!-- Links -->
11 <a NAME="top"></A>
12 <table WIDTH="100%" class="links">
13 <TR>
14 <TD class="font10">
15 Links:
16 <A HREF="#children_summary" class="links" title="Classes extended from ImageThumbnailWidget">Child Classes</A>
17 <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
18 <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
19 <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>
20 <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>
21 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22 <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23 </TD>
24 </TR>
25 </TABLE>
26 <BR>
27 <!-- Start of Class Data -->
28 <H2>
29 Class ImageThumbnailWidget
30 </H2> (line <span class="linenumber">20</span>)
31 <pre>
32 <a href="../phpHtmlLib/Container.html">Container</a>
33 |
34 --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
35 |
36 --ImageThumbnailWidget</pre>
37 <p>
38 <b><i>Located in File: Program_Root/widgets/ImageThumbnailWidget.inc</i></b><br>
39 </p>
40 <hr>
41 This widget creates a N by x visual table of thumbnails.
42 <br />
43
44 <UL>
45 <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
46 </UL>
47 <hr>
48 <!-- =========== VAR SUMMARY =========== -->
49 <A NAME='var_summary'><!-- --></A>
50 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
51 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
52 <TD>
53 <span CLASS="font12bold">Class Variable Summary</span>
54 <A HREF="#top" CLASS="links">^TOP</A>
55 </TD>
56 </TR>
57
58 <!-- =========== Summary =========== -->
59 <TR BGCOLOR='white' CLASS='TableRowColor'>
60 <TD>
61 <CODE><B><A HREF="../phpHtmlLib/ImageThumbnailWidget.html#var$_columns">$_columns</A></B></CODE>
62 <BR>
63 <blockquote> The number of columns for a page. </blockquote>
64 <blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
65 </TD>
66 </TR>
67 <!-- =========== Summary =========== -->
68 <TR BGCOLOR='white' CLASS='TableRowColor'>
69 <TD>
70 <CODE><B><A HREF="../phpHtmlLib/ImageThumbnailWidget.html#var$_global_prefix">$_global_prefix</A></B></CODE>
71 <BR>
72 <blockquote> holds the prefix for all variables that are added to a url, so we can possibly have more then 1 of these per page. </blockquote>
73 <blockquote> Default Value: <CODE>->''<-</CODE> </blockquote>
74 </TD>
75 </TR>
76 <!-- =========== Summary =========== -->
77 <TR BGCOLOR='white' CLASS='TableRowColor'>
78 <TD>
79 <CODE><B><A HREF="../phpHtmlLib/ImageThumbnailWidget.html#var$_offsetVar">$_offsetVar</A></B></CODE>
80 <BR>
81 <blockquote> Holds the name of the offset variable. It's prefixed w/ the _global_prefix var. </blockquote>
82 <blockquote> Default Value: <CODE>->&nbsp;'offset'<-</CODE> </blockquote>
83 </TD>
84 </TR>
85 <!-- =========== Summary =========== -->
86 <TR BGCOLOR='white' CLASS='TableRowColor'>
87 <TD>
88 <CODE><B><A HREF="../phpHtmlLib/ImageThumbnailWidget.html#var$_supported_image_types">$_supported_image_types</A></B></CODE>
89 <BR>
90 <blockquote> Array of supported image type flags. </blockquote>
91 <blockquote> Default Value: <CODE>->array("WBMP"&nbsp;=&gt;&nbsp;FALSE,<br>
92 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"PNG"&nbsp;=&gt;&nbsp;FALSE,<br>
93 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"JPG"&nbsp;=&gt;&nbsp;FALSE,<br>
94 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"GIF"&nbsp;=&gt;&nbsp;FALSE)<-</CODE> </blockquote>
95 </TD>
96 </TR>
97 </TABLE>
98 <hr>
99 <!-- =========== VAR INHERITED SUMMARY =========== -->
100 <A NAME='var_inherited_summary'><!-- --></A>
101 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
102 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
103 <TD>
104 <span CLASS="font12bold">Inherited Class Variable Summary</span>
105 <A HREF="#top" CLASS="links">^TOP</A>
106 </TD>
107 </TR>
108
109 <!-- =========== Summary =========== -->
110 <TR BGCOLOR='white'>
111 <TD>
112 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
113 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
114 <tr CLASS="tableheadingcolor">
115 <th>Variable</th>
116 <th>Default Value</th>
117 <th>Description</th>
118 </tr>
119 <tr>
120 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></td>
121 <td CLASS="font10" STYLE="white-space: nowrap">->''<-</td>
122 <td CLASS="font10">The title of the table.</td>
123 </tr>
124 <tr>
125 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></td>
126 <td CLASS="font10" STYLE="white-space: nowrap">->"100%"<-</td>
127 <td CLASS="font10">the width of the widget</td>
128 </tr>
129 </table>
130 <BR>
131 </TD>
132 </TR>
133 <!-- =========== Summary =========== -->
134 <TR BGCOLOR='white'>
135 <TD>
136 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
137 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
138 <tr CLASS="tableheadingcolor">
139 <th>Variable</th>
140 <th>Default Value</th>
141 <th>Description</th>
142 </tr>
143 <tr>
144 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></td>
145 <td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td>
146 <td CLASS="font10">The flags that tell us</td>
147 </tr>
148 </table>
149 <BR>
150 </TD>
151 </TR>
152 </TABLE>
153
154 <hr>
155 <!-- =========== METHOD SUMMARY =========== -->
156 <A NAME='method_summary'><!-- --></A>
157 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
158 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
159 <TD>
160 <span class="font12bold">Method Summary</span>
161 <A HREF="#top" CLASS="links">^TOP</A>
162 </TD>
163 </TR>
164
165 <!-- =========== Summary =========== -->
166 <TR BGCOLOR='white' CLASS='TableRowColor'>
167 <TD>
168 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodImageThumbnailWidget'>void constructor ImageThumbnailWidget ( [$width = 760], [$cols = 5], [$filedir = NULL], [$urldir = NULL] )</A></B></CODE>
169 <BR>
170 <blockquote> Constructor for this class It just sets the width for the widget. </blockquote>
171 </TD>
172 </TR>
173 <!-- =========== Summary =========== -->
174 <TR BGCOLOR='white' CLASS='TableRowColor'>
175 <TD>
176 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodbuild_filelist'>void build_filelist ( )</A></B></CODE>
177 <BR>
178 <blockquote> build the list of images </blockquote>
179 </TD>
180 </TR>
181 <!-- =========== Summary =========== -->
182 <TR BGCOLOR='white' CLASS='TableRowColor'>
183 <TD>
184 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodbuild_link_td'>void build_link_td ( $file )</A></B></CODE>
185 <BR>
186 <blockquote> build the link td. </blockquote>
187 </TD>
188 </TR>
189 <!-- =========== Summary =========== -->
190 <TR BGCOLOR='white' CLASS='TableRowColor'>
191 <TD>
192 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodbuild_page_control'>void build_page_control ( )</A></B></CODE>
193 <BR>
194 <blockquote> </blockquote>
195 </TD>
196 </TR>
197 <!-- =========== Summary =========== -->
198 <TR BGCOLOR='white' CLASS='TableRowColor'>
199 <TD>
200 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodbuild_thumbnails'>void build_thumbnails ( )</A></B></CODE>
201 <BR>
202 <blockquote> this function builds a cache dir of thumbnails, so we don't have to render thumbnails every time we hit the thumbnails page. </blockquote>
203 </TD>
204 </TR>
205 <!-- =========== Summary =========== -->
206 <TR BGCOLOR='white' CLASS='TableRowColor'>
207 <TD>
208 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodbuild_thumbnail_file'>void build_thumbnail_file ( $file )</A></B></CODE>
209 <BR>
210 <blockquote> Builds a thumbnail version of a file, and writes it to disk. </blockquote>
211 </TD>
212 </TR>
213 <!-- =========== Summary =========== -->
214 <TR BGCOLOR='white' CLASS='TableRowColor'>
215 <TD>
216 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodbuild_thumb_table'>void build_thumb_table ( )</A></B></CODE>
217 <BR>
218 <blockquote> function that will render the widget. </blockquote>
219 </TD>
220 </TR>
221 <!-- =========== Summary =========== -->
222 <TR BGCOLOR='white' CLASS='TableRowColor'>
223 <TD>
224 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodgetdirlist'>void getdirlist ( $dir )</A></B></CODE>
225 <BR>
226 <blockquote> </blockquote>
227 </TD>
228 </TR>
229 <!-- =========== Summary =========== -->
230 <TR BGCOLOR='white' CLASS='TableRowColor'>
231 <TD>
232 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodget_supported_image_formats'>void get_supported_image_formats ( )</A></B></CODE>
233 <BR>
234 <blockquote> This tests to see what type of gd lib image format this server supports. </blockquote>
235 </TD>
236 </TR>
237 <!-- =========== Summary =========== -->
238 <TR BGCOLOR='white' CLASS='TableRowColor'>
239 <TD>
240 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodis_last_page'>boolean is_last_page ( $offset )</A></B></CODE>
241 <BR>
242 <blockquote> Is thie offset for the last page? </blockquote>
243 </TD>
244 </TR>
245 <!-- =========== Summary =========== -->
246 <TR BGCOLOR='white' CLASS='TableRowColor'>
247 <TD>
248 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methoditems_per_page'>int items_per_page ( )</A></B></CODE>
249 <BR>
250 <blockquote> Calculate the # of items on a page. </blockquote>
251 </TD>
252 </TR>
253 <!-- =========== Summary =========== -->
254 <TR BGCOLOR='white' CLASS='TableRowColor'>
255 <TD>
256 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methoditem_index'>int item_index ( $offset )</A></B></CODE>
257 <BR>
258 <blockquote> Calculate the item # for the offset. </blockquote>
259 </TD>
260 </TR>
261 <!-- =========== Summary =========== -->
262 <TR BGCOLOR='white' CLASS='TableRowColor'>
263 <TD>
264 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodnum_items_on_page'>int num_items_on_page ( $offset )</A></B></CODE>
265 <BR>
266 <blockquote> Calculate the # of items to on a particular page. </blockquote>
267 </TD>
268 </TR>
269 <!-- =========== Summary =========== -->
270 <TR BGCOLOR='white' CLASS='TableRowColor'>
271 <TD>
272 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodnum_pages'>int num_pages ( )</A></B></CODE>
273 <BR>
274 <blockquote> Calculate the number of </blockquote>
275 </TD>
276 </TR>
277 <!-- =========== Summary =========== -->
278 <TR BGCOLOR='white' CLASS='TableRowColor'>
279 <TD>
280 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodoffset'>int offset ( )</A></B></CODE>
281 <BR>
282 <blockquote> Get the current value of the offset var </blockquote>
283 </TD>
284 </TR>
285 <!-- =========== Summary =========== -->
286 <TR BGCOLOR='white' CLASS='TableRowColor'>
287 <TD>
288 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodpush'>void push ( $url, $text, [$selected = FALSE] )</A></B></CODE>
289 <BR>
290 <blockquote> </blockquote>
291 </TD>
292 </TR>
293 <!-- =========== Summary =========== -->
294 <TR BGCOLOR='white' CLASS='TableRowColor'>
295 <TD>
296 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodpush_blank'>void push_blank ( [$num = 1] )</A></B></CODE>
297 <BR>
298 <blockquote> </blockquote>
299 </TD>
300 </TR>
301 <!-- =========== Summary =========== -->
302 <TR BGCOLOR='white' CLASS='TableRowColor'>
303 <TD>
304 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodpush_text'>void push_text ( $text, [$selected = FALSE] )</A></B></CODE>
305 <BR>
306 <blockquote> </blockquote>
307 </TD>
308 </TR>
309 <!-- =========== Summary =========== -->
310 <TR BGCOLOR='white' CLASS='TableRowColor'>
311 <TD>
312 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodrender'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE>
313 <BR>
314 <blockquote> Render the entire widget. this includes the page offset links, as well as the thumbnails. </blockquote>
315 </TD>
316 </TR>
317 <!-- =========== Summary =========== -->
318 <TR BGCOLOR='white' CLASS='TableRowColor'>
319 <TD>
320 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodrows_per_page'>int rows_per_page ( )</A></B></CODE>
321 <BR>
322 <blockquote> Calculates the # of rows per page possible. </blockquote>
323 </TD>
324 </TR>
325 <!-- =========== Summary =========== -->
326 <TR BGCOLOR='white' CLASS='TableRowColor'>
327 <TD>
328 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodset_cols'>void set_cols ( $cols )</A></B></CODE>
329 <BR>
330 <blockquote> set how many columns the user wants to display per row of thumbnails. </blockquote>
331 </TD>
332 </TR>
333 <!-- =========== Summary =========== -->
334 <TR BGCOLOR='white' CLASS='TableRowColor'>
335 <TD>
336 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodset_filedir'>void set_filedir ( $dir )</A></B></CODE>
337 <BR>
338 <blockquote> Set the full path on disk where the images live. </blockquote>
339 </TD>
340 </TR>
341 <!-- =========== Summary =========== -->
342 <TR BGCOLOR='white' CLASS='TableRowColor'>
343 <TD>
344 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodset_global_prefix'>void set_global_prefix ( $prefix )</A></B></CODE>
345 <BR>
346 <blockquote> This function sets a prefix for all variables that are used in the item list table on a page. This allows you to have multiple itemlists on a single html page. </blockquote>
347 </TD>
348 </TR>
349 <!-- =========== Summary =========== -->
350 <TR BGCOLOR='white' CLASS='TableRowColor'>
351 <TD>
352 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodset_maxthumbs_per_page'>void set_maxthumbs_per_page ( [$num = 10] )</A></B></CODE>
353 <BR>
354 <blockquote> set how many thumbnails to display per page. </blockquote>
355 </TD>
356 </TR>
357 <!-- =========== Summary =========== -->
358 <TR BGCOLOR='white' CLASS='TableRowColor'>
359 <TD>
360 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodset_thumbnail_dimensions'>void set_thumbnail_dimensions ( [$width = 50], [$height = 50] )</A></B></CODE>
361 <BR>
362 <blockquote> Sets all thumnail dimensions. </blockquote>
363 </TD>
364 </TR>
365 <!-- =========== Summary =========== -->
366 <TR BGCOLOR='white' CLASS='TableRowColor'>
367 <TD>
368 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodset_thumbnail_script'>void set_thumbnail_script ( $script )</A></B></CODE>
369 <BR>
370 <blockquote> Set the url for the thumbnail generation script. </blockquote>
371 </TD>
372 </TR>
373 <!-- =========== Summary =========== -->
374 <TR BGCOLOR='white' CLASS='TableRowColor'>
375 <TD>
376 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodset_urldir'>void set_urldir ( $dir )</A></B></CODE>
377 <BR>
378 <blockquote> Set the base url path where the files live on the web site. </blockquote>
379 </TD>
380 </TR>
381 <!-- =========== Summary =========== -->
382 <TR BGCOLOR='white' CLASS='TableRowColor'>
383 <TD>
384 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodstrip_offset'>void strip_offset ( $query_string )</A></B></CODE>
385 <BR>
386 <blockquote> This function strips the offset </blockquote>
387 </TD>
388 </TR>
389 <!-- =========== Summary =========== -->
390 <TR BGCOLOR='white' CLASS='TableRowColor'>
391 <TD>
392 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodtest_maxthumbs_per_page'>void test_maxthumbs_per_page ( )</A></B></CODE>
393 <BR>
394 <blockquote> Make sure the maxthumbsperpage isn't &gt; then total items. </blockquote>
395 </TD>
396 </TR>
397 <!-- =========== Summary =========== -->
398 <TR BGCOLOR='white' CLASS='TableRowColor'>
399 <TD>
400 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodtotal_items'>int total_items ( )</A></B></CODE>
401 <BR>
402 <blockquote> returns the total # of items we have to display. </blockquote>
403 </TD>
404 </TR>
405 <!-- =========== Summary =========== -->
406 <TR BGCOLOR='white' CLASS='TableRowColor'>
407 <TD>
408 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#methodwrite_thumb_to_disk'>void write_thumb_to_disk ( $file, &$img, $type )</A></B></CODE>
409 <BR>
410 <blockquote> write the image to disk. </blockquote>
411 </TD>
412 </TR>
413 <!-- =========== Summary =========== -->
414 <TR BGCOLOR='white' CLASS='TableRowColor'>
415 <TD>
416 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#method_create_thumbnail_cache_dir'>void _create_thumbnail_cache_dir ( )</A></B></CODE>
417 <BR>
418 <blockquote> Try and create the thumbnail cache dir. </blockquote>
419 </TD>
420 </TR>
421 <!-- =========== Summary =========== -->
422 <TR BGCOLOR='white' CLASS='TableRowColor'>
423 <TD>
424 <CODE><B><A HREF='../phpHtmlLib/ImageThumbnailWidget.html#method_get_file_type'>void _get_file_type ( $file )</A></B></CODE>
425 <BR>
426 <blockquote> discover the type of image based off of the extension </blockquote>
427 </TD>
428 </TR>
429 </TABLE>
430 <!-- =========== INHERITED METHOD SUMMARY =========== -->
431 <A NAME='functions_inherited'><!-- --></A>
432 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
433 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
434 <TD>
435 <span CLASS="font12bold">Inherited Method Summary</span>
436 <A HREF="#top" CLASS="links">^TOP</A>
437 </TD>
438 </TR>
439
440 <!-- =========== Summary =========== -->
441 <TR BGCOLOR='white' CLASS='TableRowColor'>
442 <TD>
443 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
444 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
445 <tr CLASS="tableheadingcolor">
446 <th>Function</th>
447 <th>Description</th>
448 </tr>
449 <tr>
450 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></td>
451 <td CLASS="font10">This gets the alignment value for the outer table</td>
452 <tr>
453 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></td>
454 <td CLASS="font10">This function provides the mechanism to build and return the css needed by this widget</td>
455 <tr>
456 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></td>
457 <td CLASS="font10">Function for returning the raw javascript that is required for this widget.</td>
458 <tr>
459 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></td>
460 <td CLASS="font10">Function for accessing the title of this widget</td>
461 <tr>
462 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></td>
463 <td CLASS="font10">Function for getting the current widget width setting.</td>
464 <tr>
465 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></td>
466 <td CLASS="font10">This function sets the align attribute for the outer table.</td>
467 <tr>
468 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></td>
469 <td CLASS="font10">Set the title for the widget.</td>
470 <tr>
471 <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></td>
472 <td CLASS="font10">Set the width for the widget.</td>
473 </table>
474 <br>
475 </TD>
476 </TR>
477 <!-- =========== Summary =========== -->
478 <TR BGCOLOR='white' CLASS='TableRowColor'>
479 <TD>
480 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
481 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
482 <tr CLASS="tableheadingcolor">
483 <th>Function</th>
484 <th>Description</th>
485 </tr>
486 <tr>
487 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></td>
488 <td CLASS="font10">The constructor.</td>
489 <tr>
490 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></td>
491 <td CLASS="font10">add content onto content stack</td>
492 <tr>
493 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></td>
494 <td CLASS="font10">Add content onto content stack so you can change the item later.</td>
495 <tr>
496 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></td>
497 <td CLASS="font10">counts the number of content objects</td>
498 <tr>
499 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td>
500 <td CLASS="font10">This flag gets the current value of the indent flag</td>
501 <tr>
502 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></td>
503 <td CLASS="font10">Same as add().</td>
504 <tr>
505 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td>
506 <td CLASS="font10">Same as add_reference NOTE : only exists for compatibility with 1.1.x</td>
507 <tr>
508 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></td>
509 <td CLASS="font10">This function is compatible with the rest of the phpHtmllib API spec.</td>
510 <tr>
511 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td>
512 <td CLASS="font10">destroy existing content and start with new content.</td>
513 <tr>
514 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td>
515 <td CLASS="font10">This function turns on the collapse flag</td>
516 <tr>
517 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td>
518 <td CLASS="font10">function to set the indent flag</td>
519 <tr>
520 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td>
521 <td CLASS="font10">This method is used to set the bitmask flags for this tag. It tells the class how to render the tag.</td>
522 </table>
523 <br>
524 </TD>
525 </TR>
526 </TABLE>
527 <hr>
528 <!-- ============ VARIABLE DETAIL =========== -->
529
530 <A NAME='variable_detail'></A>
531 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
532 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
533 <TD>
534 <span CLASS="font12bold">Variable Detail</span>
535 <A HREF="#top" CLASS="links">^TOP</A>
536 </TD>
537 </TR>
538 </TABLE>
539
540 <A NAME='var$_columns'><!-- --></A><H3>$_columns</H3> (line <span class="linenumber">64</span>)<br />
541 <b>Data type:</b> mixed<br>The number of columns for a page.
542 <br />
543
544 <UL>
545 </UL>
546 <HR>
547 <A NAME='var$_global_prefix'><!-- --></A><H3>$_global_prefix</H3> (line <span class="linenumber">99</span>)<br />
548 <b>Data type:</b> mixed<br>holds the prefix for all variables that are added to a url, so we can possibly have more then 1 of these per page.
549 <br />
550
551 <UL>
552 </UL>
553 <HR>
554 <A NAME='var$_offsetVar'><!-- --></A><H3>$_offsetVar</H3> (line <span class="linenumber">106</span>)<br />
555 <b>Data type:</b> mixed<br>Holds the name of the offset variable. It's prefixed w/ the _global_prefix var.
556 <br />
557
558 <UL>
559 </UL>
560 <HR>
561 <A NAME='var$_supported_image_types'><!-- --></A><H3>$_supported_image_types</H3> (line <span class="linenumber">86</span>)<br />
562 <b>Data type:</b> mixed<br>Array of supported image type flags.
563 <br />
564
565 <UL>
566 </UL>
567 <HR>
568 <hr>
569 <!-- ============ METHOD DETAIL =========== -->
570
571 <A NAME='method_detail'></A>
572 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
573 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
574 <TD>
575 <span class="font12bold">Method Detail</span>
576 <A HREF="#top" CLASS="links">^TOP</A>
577 </TD>
578 </TR>
579 </TABLE>
580 <BR>
581 <DIV CLASS="function">
582 <A NAME='methodImageThumbnailWidget'><!-- --></A>
583 <SPAN CLASS="font12bold">Constructor ImageThumbnailWidget</SPAN> (line <span class="linenumber">121</span>)
584 <BR>
585 <SPAN CLASS="font10bold">Usage : </SPAN>
586 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
587 <span class="font10bold" style="color: #0000FF">ImageThumbnailWidget(
588 [int
589 $width = 760], [int
590 $cols = 5], [mixed
591 $filedir = NULL], [mixed
592 $urldir = NULL])</SPAN>
593 <BR>
594
595 <BR>
596 <SPAN CLASS="font10bold">Description : </SPAN>
597 Constructor for this class It just sets the width for the widget.
598 <br />
599
600 <DL>
601 <DT class="font10bold">Function Parameters:</DT>
602 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$width</SPAN></SPAN> - the width of the widget</DD>
603 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$cols</SPAN></SPAN> - the number of columns of images the default is 5.</DD>
604
605 <DT class="font10bold">Function Info:</DT>
606 </DL>
607 </DIV>
608 <BR>
609 <DIV CLASS="function">
610 <A NAME='methodbuild_filelist'><!-- --></A>
611 <SPAN CLASS="font12bold">build_filelist</SPAN> (line <span class="linenumber">364</span>)
612 <BR>
613 <SPAN CLASS="font10bold">Usage : </SPAN>
614 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
615 <span class="font10bold" style="color: #0000FF">build_filelist(
616 )</SPAN>
617 <BR>
618
619 <BR>
620 <SPAN CLASS="font10bold">Description : </SPAN>
621 build the list of images
622 <br />
623 <p>from a directory on disk</p>
624 <DL>
625
626 <DT class="font10bold">Function Info:</DT>
627 </DL>
628 </DIV>
629 <BR>
630 <DIV CLASS="function">
631 <A NAME='methodbuild_link_td'><!-- --></A>
632 <SPAN CLASS="font12bold">build_link_td</SPAN> (line <span class="linenumber">400</span>)
633 <BR>
634 <SPAN CLASS="font10bold">Usage : </SPAN>
635 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
636 <span class="font10bold" style="color: #0000FF">build_link_td(
637 mixed
638 $file)</SPAN>
639 <BR>
640
641 <BR>
642 <SPAN CLASS="font10bold">Description : </SPAN>
643 build the link td.
644 <br />
645
646 <DL>
647
648 <DT class="font10bold">Function Info:</DT>
649 </DL>
650 </DIV>
651 <BR>
652 <DIV CLASS="function">
653 <A NAME='methodbuild_page_control'><!-- --></A>
654 <SPAN CLASS="font12bold">build_page_control</SPAN> (line <span class="linenumber">435</span>)
655 <BR>
656 <SPAN CLASS="font10bold">Usage : </SPAN>
657 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
658 <span class="font10bold" style="color: #0000FF">build_page_control(
659 )</SPAN>
660 <BR>
661
662 <BR>
663 <SPAN CLASS="font10bold">Description : </SPAN>
664
665 <br />
666
667 <DL>
668
669 <DT class="font10bold">Function Info:</DT>
670 </DL>
671 </DIV>
672 <BR>
673 <DIV CLASS="function">
674 <A NAME='methodbuild_thumbnails'><!-- --></A>
675 <SPAN CLASS="font12bold">build_thumbnails</SPAN> (line <span class="linenumber">567</span>)
676 <BR>
677 <SPAN CLASS="font10bold">Usage : </SPAN>
678 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
679 <span class="font10bold" style="color: #0000FF">build_thumbnails(
680 )</SPAN>
681 <BR>
682
683 <BR>
684 <SPAN CLASS="font10bold">Description : </SPAN>
685 this function builds a cache dir of thumbnails, so we don't have to render thumbnails every time we hit the thumbnails page.
686 <br />
687
688 <DL>
689
690 <DT class="font10bold">Function Info:</DT>
691 </DL>
692 </DIV>
693 <BR>
694 <DIV CLASS="function">
695 <A NAME='methodbuild_thumbnail_file'><!-- --></A>
696 <SPAN CLASS="font12bold">build_thumbnail_file</SPAN> (line <span class="linenumber">593</span>)
697 <BR>
698 <SPAN CLASS="font10bold">Usage : </SPAN>
699 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
700 <span class="font10bold" style="color: #0000FF">build_thumbnail_file(
701 mixed
702 $file, string
703 $filename)</SPAN>
704 <BR>
705
706 <BR>
707 <SPAN CLASS="font10bold">Description : </SPAN>
708 Builds a thumbnail version of a file, and writes it to disk.
709 <br />
710
711 <DL>
712 <DT class="font10bold">Function Parameters:</DT>
713 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$filename</SPAN></SPAN> - the filename to thumbnail</DD>
714
715 <DT class="font10bold">Function Info:</DT>
716 </DL>
717 </DIV>
718 <BR>
719 <DIV CLASS="function">
720 <A NAME='methodbuild_thumb_table'><!-- --></A>
721 <SPAN CLASS="font12bold">build_thumb_table</SPAN> (line <span class="linenumber">496</span>)
722 <BR>
723 <SPAN CLASS="font10bold">Usage : </SPAN>
724 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
725 <span class="font10bold" style="color: #0000FF">build_thumb_table(
726 )</SPAN>
727 <BR>
728
729 <BR>
730 <SPAN CLASS="font10bold">Description : </SPAN>
731 function that will render the widget.
732 <br />
733 <p>child class should override this.</p>
734 <DL>
735
736 <DT class="font10bold">Function Info:</DT>
737 </DL>
738 </DIV>
739 <BR>
740 <DIV CLASS="function">
741 <A NAME='methodgetdirlist'><!-- --></A>
742 <SPAN CLASS="font12bold">getdirlist</SPAN> (line <span class="linenumber">370</span>)
743 <BR>
744 <SPAN CLASS="font10bold">Usage : </SPAN>
745 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
746 <span class="font10bold" style="color: #0000FF">getdirlist(
747 mixed
748 $dir)</SPAN>
749 <BR>
750
751 <BR>
752 <SPAN CLASS="font10bold">Description : </SPAN>
753
754 <br />
755
756 <DL>
757
758 <DT class="font10bold">Function Info:</DT>
759 </DL>
760 </DIV>
761 <BR>
762 <DIV CLASS="function">
763 <A NAME='methodget_supported_image_formats'><!-- --></A>
764 <SPAN CLASS="font12bold">get_supported_image_formats</SPAN> (line <span class="linenumber">232</span>)
765 <BR>
766 <SPAN CLASS="font10bold">Usage : </SPAN>
767 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
768 <span class="font10bold" style="color: #0000FF">get_supported_image_formats(
769 )</SPAN>
770 <BR>
771
772 <BR>
773 <SPAN CLASS="font10bold">Description : </SPAN>
774 This tests to see what type of gd lib image format this server supports.
775 <br />
776
777 <DL>
778
779 <DT class="font10bold">Function Info:</DT>
780 </DL>
781 </DIV>
782 <BR>
783 <DIV CLASS="function">
784 <A NAME='methodis_last_page'><!-- --></A>
785 <SPAN CLASS="font12bold">is_last_page</SPAN> (line <span class="linenumber">316</span>)
786 <BR>
787 <SPAN CLASS="font10bold">Usage : </SPAN>
788 <span class="font10bold" style="color: #FF0000">boolean</SPAN>&nbsp;
789 <span class="font10bold" style="color: #0000FF">is_last_page(
790 int
791 $offset)</SPAN>
792 <BR>
793
794 <BR>
795 <SPAN CLASS="font10bold">Description : </SPAN>
796 Is thie offset for the last page?
797 <br />
798
799 <DL>
800 <DT class="font10bold">Function Parameters:</DT>
801 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$offset</SPAN></SPAN> - page offset</DD>
802
803 <DT class="font10bold">Function Info:</DT>
804 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - TRUE:FALSE</DD>
805 </DL>
806 </DIV>
807 <BR>
808 <DIV CLASS="function">
809 <A NAME='methoditems_per_page'><!-- --></A>
810 <SPAN CLASS="font12bold">items_per_page</SPAN> (line <span class="linenumber">282</span>)
811 <BR>
812 <SPAN CLASS="font10bold">Usage : </SPAN>
813 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
814 <span class="font10bold" style="color: #0000FF">items_per_page(
815 )</SPAN>
816 <BR>
817
818 <BR>
819 <SPAN CLASS="font10bold">Description : </SPAN>
820 Calculate the # of items on a page.
821 <br />
822
823 <DL>
824
825 <DT class="font10bold">Function Info:</DT>
826 </DL>
827 </DIV>
828 <BR>
829 <DIV CLASS="function">
830 <A NAME='methoditem_index'><!-- --></A>
831 <SPAN CLASS="font12bold">item_index</SPAN> (line <span class="linenumber">353</span>)
832 <BR>
833 <SPAN CLASS="font10bold">Usage : </SPAN>
834 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
835 <span class="font10bold" style="color: #0000FF">item_index(
836 mixed
837 $offset)</SPAN>
838 <BR>
839
840 <BR>
841 <SPAN CLASS="font10bold">Description : </SPAN>
842 Calculate the item # for the offset.
843 <br />
844
845 <DL>
846
847 <DT class="font10bold">Function Info:</DT>
848 </DL>
849 </DIV>
850 <BR>
851 <DIV CLASS="function">
852 <A NAME='methodnum_items_on_page'><!-- --></A>
853 <SPAN CLASS="font12bold">num_items_on_page</SPAN> (line <span class="linenumber">338</span>)
854 <BR>
855 <SPAN CLASS="font10bold">Usage : </SPAN>
856 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
857 <span class="font10bold" style="color: #0000FF">num_items_on_page(
858 int
859 $offset)</SPAN>
860 <BR>
861
862 <BR>
863 <SPAN CLASS="font10bold">Description : </SPAN>
864 Calculate the # of items to on a particular page.
865 <br />
866
867 <DL>
868 <DT class="font10bold">Function Parameters:</DT>
869 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$offset</SPAN></SPAN> - page offset #</DD>
870
871 <DT class="font10bold">Function Info:</DT>
872 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - # of items on offset's page.</DD>
873 </DL>
874 </DIV>
875 <BR>
876 <DIV CLASS="function">
877 <A NAME='methodnum_pages'><!-- --></A>
878 <SPAN CLASS="font12bold">num_pages</SPAN> (line <span class="linenumber">297</span>)
879 <BR>
880 <SPAN CLASS="font10bold">Usage : </SPAN>
881 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
882 <span class="font10bold" style="color: #0000FF">num_pages(
883 )</SPAN>
884 <BR>
885
886 <BR>
887 <SPAN CLASS="font10bold">Description : </SPAN>
888 Calculate the number of
889 <br />
890 <p>pages possible for this list of thumbnails. It depends on the # of columns, and the max thumbs per page, and the total.</p>
891 <DL>
892
893 <DT class="font10bold">Function Info:</DT>
894 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - # of pages.</DD>
895 </DL>
896 </DIV>
897 <BR>
898 <DIV CLASS="function">
899 <A NAME='methodoffset'><!-- --></A>
900 <SPAN CLASS="font12bold">offset</SPAN> (line <span class="linenumber">250</span>)
901 <BR>
902 <SPAN CLASS="font10bold">Usage : </SPAN>
903 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
904 <span class="font10bold" style="color: #0000FF">offset(
905 )</SPAN>
906 <BR>
907
908 <BR>
909 <SPAN CLASS="font10bold">Description : </SPAN>
910 Get the current value of the offset var
911 <br />
912
913 <DL>
914
915 <DT class="font10bold">Function Info:</DT>
916 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the page offset</DD>
917 </DL>
918 </DIV>
919 <BR>
920 <DIV CLASS="function">
921 <A NAME='methodpush'><!-- --></A>
922 <SPAN CLASS="font12bold">push</SPAN> (line <span class="linenumber">133</span>)
923 <BR>
924 <SPAN CLASS="font10bold">Usage : </SPAN>
925 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
926 <span class="font10bold" style="color: #0000FF">push(
927 mixed
928 $url, mixed
929 $text, [mixed
930 $selected = FALSE])</SPAN>
931 <BR>
932
933 <BR>
934 <SPAN CLASS="font10bold">Description : </SPAN>
935
936 <br />
937
938 <DL>
939
940 <DT class="font10bold">Function Info:</DT>
941 </DL>
942 </DIV>
943 <BR>
944 <DIV CLASS="function">
945 <A NAME='methodpush_blank'><!-- --></A>
946 <SPAN CLASS="font12bold">push_blank</SPAN> (line <span class="linenumber">138</span>)
947 <BR>
948 <SPAN CLASS="font10bold">Usage : </SPAN>
949 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
950 <span class="font10bold" style="color: #0000FF">push_blank(
951 [mixed
952 $num = 1])</SPAN>
953 <BR>
954
955 <BR>
956 <SPAN CLASS="font10bold">Description : </SPAN>
957
958 <br />
959
960 <DL>
961
962 <DT class="font10bold">Function Info:</DT>
963 </DL>
964 </DIV>
965 <BR>
966 <DIV CLASS="function">
967 <A NAME='methodpush_text'><!-- --></A>
968 <SPAN CLASS="font12bold">push_text</SPAN> (line <span class="linenumber">143</span>)
969 <BR>
970 <SPAN CLASS="font10bold">Usage : </SPAN>
971 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
972 <span class="font10bold" style="color: #0000FF">push_text(
973 mixed
974 $text, [mixed
975 $selected = FALSE])</SPAN>
976 <BR>
977
978 <BR>
979 <SPAN CLASS="font10bold">Description : </SPAN>
980
981 <br />
982
983 <DL>
984
985 <DT class="font10bold">Function Info:</DT>
986 </DL>
987 </DIV>
988 <BR>
989 <DIV CLASS="function">
990 <A NAME='methodrender'><!-- --></A>
991 <SPAN CLASS="font12bold">render</SPAN> (line <span class="linenumber">538</span>)
992 <BR>
993 <SPAN CLASS="font10bold">Usage : </SPAN>
994 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
995 <span class="font10bold" style="color: #0000FF">render(
996 [int
997 $indent_level = 1], int
998 $output_debug)</SPAN>
999 <BR>
1000
1001 <BR>
1002 <SPAN CLASS="font10bold">Description : </SPAN>
1003 Render the entire widget. this includes the page offset links, as well as the thumbnails.
1004 <br />
1005
1006 <DL>
1007 <DT class="font10bold">Function Parameters:</DT>
1008 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$indent_level</SPAN></SPAN> - the indentation level for the container.</DD>
1009 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$output_debug</SPAN></SPAN> - the output debug flag to maintain compatibility w/ the API.</DD>
1010
1011 <DT class="font10bold">Function Info:</DT>
1012 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - the raw html output.</DD>
1013 </DL>
1014 </DIV>
1015 <BR>
1016 <DIV CLASS="function">
1017 <A NAME='methodrows_per_page'><!-- --></A>
1018 <SPAN CLASS="font12bold">rows_per_page</SPAN> (line <span class="linenumber">264</span>)
1019 <BR>
1020 <SPAN CLASS="font10bold">Usage : </SPAN>
1021 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
1022 <span class="font10bold" style="color: #0000FF">rows_per_page(
1023 )</SPAN>
1024 <BR>
1025
1026 <BR>
1027 <SPAN CLASS="font10bold">Description : </SPAN>
1028 Calculates the # of rows per page possible.
1029 <br />
1030
1031 <DL>
1032
1033 <DT class="font10bold">Function Info:</DT>
1034 </DL>
1035 </DIV>
1036 <BR>
1037 <DIV CLASS="function">
1038 <A NAME='methodset_cols'><!-- --></A>
1039 <SPAN CLASS="font12bold">set_cols</SPAN> (line <span class="linenumber">192</span>)
1040 <BR>
1041 <SPAN CLASS="font10bold">Usage : </SPAN>
1042 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1043 <span class="font10bold" style="color: #0000FF">set_cols(
1044 mixed
1045 $cols)</SPAN>
1046 <BR>
1047
1048 <BR>
1049 <SPAN CLASS="font10bold">Description : </SPAN>
1050 set how many columns the user wants to display per row of thumbnails.
1051 <br />
1052
1053 <DL>
1054
1055 <DT class="font10bold">Function Info:</DT>
1056 </DL>
1057 </DIV>
1058 <BR>
1059 <DIV CLASS="function">
1060 <A NAME='methodset_filedir'><!-- --></A>
1061 <SPAN CLASS="font12bold">set_filedir</SPAN> (line <span class="linenumber">175</span>)
1062 <BR>
1063 <SPAN CLASS="font10bold">Usage : </SPAN>
1064 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1065 <span class="font10bold" style="color: #0000FF">set_filedir(
1066 mixed
1067 $dir)</SPAN>
1068 <BR>
1069
1070 <BR>
1071 <SPAN CLASS="font10bold">Description : </SPAN>
1072 Set the full path on disk where the images live.
1073 <br />
1074
1075 <DL>
1076
1077 <DT class="font10bold">Function Info:</DT>
1078 </DL>
1079 </DIV>
1080 <BR>
1081 <DIV CLASS="function">
1082 <A NAME='methodset_global_prefix'><!-- --></A>
1083 <SPAN CLASS="font12bold">set_global_prefix</SPAN> (line <span class="linenumber">156</span>)
1084 <BR>
1085 <SPAN CLASS="font10bold">Usage : </SPAN>
1086 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1087 <span class="font10bold" style="color: #0000FF">set_global_prefix(
1088 string
1089 $prefix)</SPAN>
1090 <BR>
1091
1092 <BR>
1093 <SPAN CLASS="font10bold">Description : </SPAN>
1094 This function sets a prefix for all variables that are used in the item list table on a page. This allows you to have multiple itemlists on a single html page.
1095 <br />
1096
1097 <DL>
1098 <DT class="font10bold">Function Parameters:</DT>
1099 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$prefix</SPAN></SPAN> - the prefix for all vars.</DD>
1100
1101 <DT class="font10bold">Function Info:</DT>
1102 </DL>
1103 </DIV>
1104 <BR>
1105 <DIV CLASS="function">
1106 <A NAME='methodset_maxthumbs_per_page'><!-- --></A>
1107 <SPAN CLASS="font12bold">set_maxthumbs_per_page</SPAN> (line <span class="linenumber">200</span>)
1108 <BR>
1109 <SPAN CLASS="font10bold">Usage : </SPAN>
1110 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1111 <span class="font10bold" style="color: #0000FF">set_maxthumbs_per_page(
1112 [mixed
1113 $num = 10])</SPAN>
1114 <BR>
1115
1116 <BR>
1117 <SPAN CLASS="font10bold">Description : </SPAN>
1118 set how many thumbnails to display per page.
1119 <br />
1120
1121 <DL>
1122
1123 <DT class="font10bold">Function Info:</DT>
1124 </DL>
1125 </DIV>
1126 <BR>
1127 <DIV CLASS="function">
1128 <A NAME='methodset_thumbnail_dimensions'><!-- --></A>
1129 <SPAN CLASS="font12bold">set_thumbnail_dimensions</SPAN> (line <span class="linenumber">221</span>)
1130 <BR>
1131 <SPAN CLASS="font10bold">Usage : </SPAN>
1132 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1133 <span class="font10bold" style="color: #0000FF">set_thumbnail_dimensions(
1134 [int
1135 $width = 50], [int
1136 $height = 50])</SPAN>
1137 <BR>
1138
1139 <BR>
1140 <SPAN CLASS="font10bold">Description : </SPAN>
1141 Sets all thumnail dimensions.
1142 <br />
1143
1144 <DL>
1145 <DT class="font10bold">Function Parameters:</DT>
1146 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$width</SPAN></SPAN> - thumbnail width</DD>
1147 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$height</SPAN></SPAN> - thumbnail height</DD>
1148
1149 <DT class="font10bold">Function Info:</DT>
1150 </DL>
1151 </DIV>
1152 <BR>
1153 <DIV CLASS="function">
1154 <A NAME='methodset_thumbnail_script'><!-- --></A>
1155 <SPAN CLASS="font12bold">set_thumbnail_script</SPAN> (line <span class="linenumber">166</span>)
1156 <BR>
1157 <SPAN CLASS="font10bold">Usage : </SPAN>
1158 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1159 <span class="font10bold" style="color: #0000FF">set_thumbnail_script(
1160 mixed
1161 $script)</SPAN>
1162 <BR>
1163
1164 <BR>
1165 <SPAN CLASS="font10bold">Description : </SPAN>
1166 Set the url for the thumbnail generation script.
1167 <br />
1168
1169 <DL>
1170
1171 <DT class="font10bold">Function Info:</DT>
1172 </DL>
1173 </DIV>
1174 <BR>
1175 <DIV CLASS="function">
1176 <A NAME='methodset_urldir'><!-- --></A>
1177 <SPAN CLASS="font12bold">set_urldir</SPAN> (line <span class="linenumber">184</span>)
1178 <BR>
1179 <SPAN CLASS="font10bold">Usage : </SPAN>
1180 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1181 <span class="font10bold" style="color: #0000FF">set_urldir(
1182 mixed
1183 $dir)</SPAN>
1184 <BR>
1185
1186 <BR>
1187 <SPAN CLASS="font10bold">Description : </SPAN>
1188 Set the base url path where the files live on the web site.
1189 <br />
1190
1191 <DL>
1192
1193 <DT class="font10bold">Function Info:</DT>
1194 </DL>
1195 </DIV>
1196 <BR>
1197 <DIV CLASS="function">
1198 <A NAME='methodstrip_offset'><!-- --></A>
1199 <SPAN CLASS="font12bold">strip_offset</SPAN> (line <span class="linenumber">419</span>)
1200 <BR>
1201 <SPAN CLASS="font10bold">Usage : </SPAN>
1202 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1203 <span class="font10bold" style="color: #0000FF">strip_offset(
1204 mixed
1205 $query_string)</SPAN>
1206 <BR>
1207
1208 <BR>
1209 <SPAN CLASS="font10bold">Description : </SPAN>
1210 This function strips the offset
1211 <br />
1212
1213 <DL>
1214
1215 <DT class="font10bold">Function Info:</DT>
1216 </DL>
1217 </DIV>
1218 <BR>
1219 <DIV CLASS="function">
1220 <A NAME='methodtest_maxthumbs_per_page'><!-- --></A>
1221 <SPAN CLASS="font12bold">test_maxthumbs_per_page</SPAN> (line <span class="linenumber">209</span>)
1222 <BR>
1223 <SPAN CLASS="font10bold">Usage : </SPAN>
1224 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1225 <span class="font10bold" style="color: #0000FF">test_maxthumbs_per_page(
1226 )</SPAN>
1227 <BR>
1228
1229 <BR>
1230 <SPAN CLASS="font10bold">Description : </SPAN>
1231 Make sure the maxthumbsperpage isn't &gt; then total items.
1232 <br />
1233
1234 <DL>
1235
1236 <DT class="font10bold">Function Info:</DT>
1237 </DL>
1238 </DIV>
1239 <BR>
1240 <DIV CLASS="function">
1241 <A NAME='methodtotal_items'><!-- --></A>
1242 <SPAN CLASS="font12bold">total_items</SPAN> (line <span class="linenumber">327</span>)
1243 <BR>
1244 <SPAN CLASS="font10bold">Usage : </SPAN>
1245 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
1246 <span class="font10bold" style="color: #0000FF">total_items(
1247 )</SPAN>
1248 <BR>
1249
1250 <BR>
1251 <SPAN CLASS="font10bold">Description : </SPAN>
1252 returns the total # of items we have to display.
1253 <br />
1254
1255 <DL>
1256
1257 <DT class="font10bold">Function Info:</DT>
1258 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - total items.</DD>
1259 </DL>
1260 </DIV>
1261 <BR>
1262 <DIV CLASS="function">
1263 <A NAME='methodwrite_thumb_to_disk'><!-- --></A>
1264 <SPAN CLASS="font12bold">write_thumb_to_disk</SPAN> (line <span class="linenumber">661</span>)
1265 <BR>
1266 <SPAN CLASS="font10bold">Usage : </SPAN>
1267 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1268 <span class="font10bold" style="color: #0000FF">write_thumb_to_disk(
1269 mixed
1270 $file, mixed
1271 &$img, mixed
1272 $type)</SPAN>
1273 <BR>
1274
1275 <BR>
1276 <SPAN CLASS="font10bold">Description : </SPAN>
1277 write the image to disk.
1278 <br />
1279 <p>We assume we have write permissions to the images dir.</p>
1280 <DL>
1281
1282 <DT class="font10bold">Function Info:</DT>
1283 </DL>
1284 </DIV>
1285 <BR>
1286 <DIV CLASS="function">
1287 <A NAME='method_create_thumbnail_cache_dir'><!-- --></A>
1288 <SPAN CLASS="font12bold">_create_thumbnail_cache_dir</SPAN> (line <span class="linenumber">682</span>)
1289 <BR>
1290 <SPAN CLASS="font10bold">Usage : </SPAN>
1291 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1292 <span class="font10bold" style="color: #0000FF">_create_thumbnail_cache_dir(
1293 )</SPAN>
1294 <BR>
1295
1296 <BR>
1297 <SPAN CLASS="font10bold">Description : </SPAN>
1298 Try and create the thumbnail cache dir.
1299 <br />
1300
1301 <DL>
1302
1303 <DT class="font10bold">Function Info:</DT>
1304 </DL>
1305 </DIV>
1306 <BR>
1307 <DIV CLASS="function">
1308 <A NAME='method_get_file_type'><!-- --></A>
1309 <SPAN CLASS="font12bold">_get_file_type</SPAN> (line <span class="linenumber">638</span>)
1310 <BR>
1311 <SPAN CLASS="font10bold">Usage : </SPAN>
1312 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1313 <span class="font10bold" style="color: #0000FF">_get_file_type(
1314 mixed
1315 $file, string
1316 $filename)</SPAN>
1317 <BR>
1318
1319 <BR>
1320 <SPAN CLASS="font10bold">Description : </SPAN>
1321 discover the type of image based off of the extension
1322 <br />
1323
1324 <DL>
1325 <DT class="font10bold">Function Parameters:</DT>
1326 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$filename</SPAN></SPAN> - the filename</DD>
1327
1328 <DT class="font10bold">Function Info:</DT>
1329 </DL>
1330 </DIV>
1331 <BR>
1332 <div id="credit">
1333 <hr>
1334 Documention generated on Thu, 20 Feb 2003 16:23:01 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
1335 </div>
1336 </body>
1337 </html>

MailToCvsAdmin">MailToCvsAdmin
ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed