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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations)
Thu Jan 30 03:29:25 2003 UTC (22 years, 9 months ago) by jonen
Branch: MAIN
Branch point for: no_vendor_tag
File MIME type: text/html 
Initial revision
1 jonen 1.1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>
2     <!--NewPage-->
3     <HTML>
4     <HEAD>
5     <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:32 -0800' -->
6     <TITLE>Docs For Class ImageThumbnailWidget</TITLE>
7     <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>
8     </HEAD>
9     <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10    
11    
12     <!-- Links -->
13     <a NAME="top"></A>
14     <table WIDTH="100%" class="links">
15     <TR>
16     <TD class="font10">
17     Links:
18     <A HREF="#children_summary" class="links" title="Classes extended from ImageThumbnailWidget">Child Classes</A>
19     <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
20     <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
21     <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A>
22     <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A>
23     <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
24     <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>
25     </TD>
26     </TR>
27     </TABLE>
28     <BR>
29    
30     <!-- Start of Class Data -->
31     <H2>
32     Class ImageThumbnailWidget
33     </H2>
34    
35     <pre>
36     <pre><a href="../phpHtmlLib/Container.html">Container</a>
37     |
38     --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
39     |
40     --ImageThumbnailWidget</pre>
41     </pre>
42    
43     <A NAME="children_summary"</A>
44     <H3>
45     Classes extended from ImageThumbnailWidget: <A HREF="#top" CLASS="links">^TOP</A>
46     </H3>
47    
48     <p>
49     <b><i>Located in File: Program_Root/widgets/ImageThumbnailWidget.inc</i></b><br>
50     </p>
51     <hr>
52     <!-- ========== Info from phpDoc block ========= -->
53     This widget creates a N by x visual table of
54     thumbnails.
55     <BR>
56    
57    
58     <UL>
59    
60     <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
61    
62     <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>
63    
64     </UL>
65    
66     <hr>
67     <!-- =========== VAR SUMMARY =========== -->
68     <A NAME='var_summary'><!-- --></A>
69     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
70     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
71     <TD>
72     <span CLASS="font12bold">Class Variable Summary</span>
73     <A HREF="#top" CLASS="links">^TOP</A>
74     </TD>
75     </TR>
76    
77    
78     <!-- =========== Summary =========== -->
79     <TR BGCOLOR='white' CLASS='TableRowColor'>
80     <TD>
81     <CODE><B><A HREF='ImageThumbnailWidget.html#$_columns'>$_columns</A></B></CODE>
82     <BR>
83     <blockquote> The number of columns for a
84     page. </blockquote>
85     <blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
86     </TD>
87     </TR>
88    
89     <!-- =========== Summary =========== -->
90     <TR BGCOLOR='white' CLASS='TableRowColor'>
91     <TD>
92     <CODE><B><A HREF='ImageThumbnailWidget.html#$_global_prefix'>$_global_prefix</A></B></CODE>
93     <BR>
94     <blockquote> holds the prefix for all variables </blockquote>
95     <blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
96     </TD>
97     </TR>
98    
99     <!-- =========== Summary =========== -->
100     <TR BGCOLOR='white' CLASS='TableRowColor'>
101     <TD>
102     <CODE><B><A HREF='ImageThumbnailWidget.html#$_offsetVar'>$_offsetVar</A></B></CODE>
103     <BR>
104     <blockquote> Holds the name of the offset
105     variable. </blockquote>
106     <blockquote> Default Value: <CODE>->offset<-</CODE> </blockquote>
107     </TD>
108     </TR>
109    
110     <!-- =========== Summary =========== -->
111     <TR BGCOLOR='white' CLASS='TableRowColor'>
112     <TD>
113     <CODE><B><A HREF='ImageThumbnailWidget.html#$_supported_image_types'>$_supported_image_types</A></B></CODE>
114     <BR>
115     <blockquote> Array of supported image
116     type flags. </blockquote>
117     <blockquote> Default Value: <CODE>->array(&quot;WBMP&quot; =&gt; FALSE,
118     &quot;PNG&quot; =&gt; FALSE,
119     &quot;JPG&quot; =&gt; FALSE,
120     &quot;GIF&quot; =&gt; FALSE)<-</CODE> </blockquote>
121     </TD>
122     </TR>
123    
124     </TABLE>
125    
126     <hr>
127     <!-- =========== VAR INHERITED SUMMARY =========== -->
128     <A NAME='var_inherited_summary'><!-- --></A>
129     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
130     <TR CLASS='TableHeadingColor'>
131     <TD>
132     <span CLASS="font12bold">Inherited Class Variable Summary</span>
133     <A HREF="#top" CLASS="links">^TOP</A>
134     </TD>
135     </TR>
136    
137    
138     <!-- =========== Summary =========== -->
139     <TR BGCOLOR='white'>
140     <TD>
141     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
142     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
143     <tr CLASS="tableheadingcolor">
144     <th>Variable</th>
145     <th>Default Value</th>
146     <th>Description</th>
147     </tr>
148    
149     <tr>
150     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$title'>$title</A></td>
151     <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
152     <td CLASS="font10">The title of the table.</td>
153     </tr>
154    
155     <tr>
156     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$width'>$width</A></td>
157     <td CLASS="font10" STYLE="white-space: nowrap">->100%<-</td>
158     <td CLASS="font10">the width of the widget</td>
159     </tr>
160    
161     </table>
162     <BR>
163     </TD>
164     </TR>
165    
166     <!-- =========== Summary =========== -->
167     <TR BGCOLOR='white'>
168     <TD>
169     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
170     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
171     <tr CLASS="tableheadingcolor">
172     <th>Variable</th>
173     <th>Default Value</th>
174     <th>Description</th>
175     </tr>
176    
177     <tr>
178     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>
179     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
180     <td CLASS="font10">Flag for pretty (indented) output</td>
181     </tr>
182    
183     <tr>
184     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>
185     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
186     <td CLASS="font10">Do we render a newline after the
187     contents has been rendered?</td>
188     </tr>
189    
190     </table>
191     <BR>
192     </TD>
193     </TR>
194    
195     </TABLE>
196    
197     <hr>
198     <!-- =========== INHERITED METHOD SUMMARY =========== -->
199     <A NAME='functions_inherited'><!-- --></A>
200     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
201     <TR CLASS='TableHeadingColor'>
202     <TD>
203     <span CLASS="font12bold">Inherited Method Summary</span>
204     <A HREF="#top" CLASS="links">^TOP</A>
205     </TD>
206     </TR>
207    
208    
209     <!-- =========== Summary =========== -->
210     <TR BGCOLOR='white' CLASS='TableRowColor'>
211     <TD>
212     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
213     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
214     <tr CLASS="tableheadingcolor">
215     <th>Function</th>
216     <th>Description</th>
217     </tr>
218    
219     <tr>
220     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_align'>get_align ( )</A></td>
221     <td CLASS="font10">This gets the alignment value
222     for the outer table</td>
223    
224     <tr>
225     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_css'>get_css ( )</A></td>
226     <td CLASS="font10">This function provides the</td>
227    
228     <tr>
229     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_javascript'>get_javascript ( )</A></td>
230     <td CLASS="font10">Function for returning the raw javascript
231     that is required for this widget.</td>
232    
233     <tr>
234     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_title'>get_title ( )</A></td>
235     <td CLASS="font10">Function for accessing the
236     title of this widget</td>
237    
238     <tr>
239     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_width'>get_width ( )</A></td>
240     <td CLASS="font10">Function for getting the current
241     widget width setting.</td>
242    
243     <tr>
244     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_align'>set_align ( $align )</A></td>
245     <td CLASS="font10">This function sets the align attribute
246     for the outer table.</td>
247    
248     <tr>
249     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_title'>set_title ( [$title = ] )</A></td>
250     <td CLASS="font10">Set the title for the widget.</td>
251    
252     <tr>
253     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_width'>set_width ( $width )</A></td>
254     <td CLASS="font10">Set the width for the widget.</td>
255    
256     </table>
257     <br>
258     </TD>
259     </TR>
260    
261     <!-- =========== Summary =========== -->
262     <TR BGCOLOR='white' CLASS='TableRowColor'>
263     <TD>
264     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
265     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
266     <tr CLASS="tableheadingcolor">
267     <th>Function</th>
268     <th>Description</th>
269     </tr>
270    
271     <tr>
272     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td>
273     <td CLASS="font10">The constructor.</td>
274    
275     <tr>
276     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td>
277     <td CLASS="font10">add content onto content stack</td>
278    
279     <tr>
280     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>
281     <td CLASS="font10">Add content onto content stack
282     so you can change the item later.</td>
283    
284     <tr>
285     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td>
286     <td CLASS="font10">counts the number of content objects</td>
287    
288     <tr>
289     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td>
290     <td CLASS="font10">This flag gets the current value
291     of the indent flag</td>
292    
293     <tr>
294     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td>
295     <td CLASS="font10">Same as add().</td>
296    
297     <tr>
298     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>
299     <td CLASS="font10">Same as add_reference
300     NOTE : only exists for compatibility with 1.1.x</td>
301    
302     <tr>
303     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>
304     <td CLASS="font10">This function is compatible with the
305     rest of the phpHtmllib API spec.</td>
306    
307     <tr>
308     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td>
309     <td CLASS="font10">destroy existing content and start with new content.</td>
310    
311     <tr>
312     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
313     <td CLASS="font10">This function turns on the collapse flag</td>
314    
315     <tr>
316     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>
317     <td CLASS="font10">function to set the indent flag</td>
318    
319     </table>
320     <br>
321     </TD>
322     </TR>
323    
324     </TABLE>
325    
326     <hr>
327     <!-- should have constructor at some point -->
328     <!-- =========== Method SUMMARY =========== -->
329     <A NAME='Method_summary'><!-- --></A>
330     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
331     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
332     <TD>
333     <span class="font12bold">Method Summary</span>
334     <A HREF="#top" CLASS="links">^TOP</A>
335     </TD>
336     </TR>
337    
338    
339     <!-- =========== Summary =========== -->
340     <TR BGCOLOR='white' CLASS='TableRowColor'>
341     <TD>
342     <CODE><B><A HREF='ImageThumbnailWidget.html#constructor ImageThumbnailWidget'>void constructor ImageThumbnailWidget ( [$width = 760], [$cols = 5], [$filedir = NULL], [$urldir = NULL] )</A></B></CODE>
343     <BR>
344     <blockquote> Constructor for this class
345     It just sets the width for the
346     widget. </blockquote>
347     </TD>
348     </TR>
349    
350     <!-- =========== Summary =========== -->
351     <TR BGCOLOR='white' CLASS='TableRowColor'>
352     <TD>
353     <CODE><B><A HREF='ImageThumbnailWidget.html#build_filelist'>void build_filelist ( )</A></B></CODE>
354     <BR>
355     <blockquote> build the list of images </blockquote>
356     </TD>
357     </TR>
358    
359     <!-- =========== Summary =========== -->
360     <TR BGCOLOR='white' CLASS='TableRowColor'>
361     <TD>
362     <CODE><B><A HREF='ImageThumbnailWidget.html#build_link_td'>void build_link_td ( $file )</A></B></CODE>
363     <BR>
364     <blockquote> build the link td. </blockquote>
365     </TD>
366     </TR>
367    
368     <!-- =========== Summary =========== -->
369     <TR BGCOLOR='white' CLASS='TableRowColor'>
370     <TD>
371     <CODE><B><A HREF='ImageThumbnailWidget.html#build_page_control'>void build_page_control ( )</A></B></CODE>
372     <BR>
373     <blockquote> </blockquote>
374     </TD>
375     </TR>
376    
377     <!-- =========== Summary =========== -->
378     <TR BGCOLOR='white' CLASS='TableRowColor'>
379     <TD>
380     <CODE><B><A HREF='ImageThumbnailWidget.html#build_thumbnails'>void build_thumbnails ( )</A></B></CODE>
381     <BR>
382     <blockquote> this function builds a cache dir of thumbnails, so we
383     don't have to render thumbnails every time we hit the
384     thumbnails page. </blockquote>
385     </TD>
386     </TR>
387    
388     <!-- =========== Summary =========== -->
389     <TR BGCOLOR='white' CLASS='TableRowColor'>
390     <TD>
391     <CODE><B><A HREF='ImageThumbnailWidget.html#build_thumbnail_file'>void build_thumbnail_file ( $file )</A></B></CODE>
392     <BR>
393     <blockquote> Builds a thumbnail version of a file,
394     and writes it to disk. </blockquote>
395     </TD>
396     </TR>
397    
398     <!-- =========== Summary =========== -->
399     <TR BGCOLOR='white' CLASS='TableRowColor'>
400     <TD>
401     <CODE><B><A HREF='ImageThumbnailWidget.html#build_thumb_table'>void build_thumb_table ( )</A></B></CODE>
402     <BR>
403     <blockquote> function that will render the widget. </blockquote>
404     </TD>
405     </TR>
406    
407     <!-- =========== Summary =========== -->
408     <TR BGCOLOR='white' CLASS='TableRowColor'>
409     <TD>
410     <CODE><B><A HREF='ImageThumbnailWidget.html#getdirlist'>void getdirlist ( $dir )</A></B></CODE>
411     <BR>
412     <blockquote> </blockquote>
413     </TD>
414     </TR>
415    
416     <!-- =========== Summary =========== -->
417     <TR BGCOLOR='white' CLASS='TableRowColor'>
418     <TD>
419     <CODE><B><A HREF='ImageThumbnailWidget.html#get_supported_image_formats'>void get_supported_image_formats ( )</A></B></CODE>
420     <BR>
421     <blockquote> This tests to see what type of gd
422     lib image format this server supports. </blockquote>
423     </TD>
424     </TR>
425    
426     <!-- =========== Summary =========== -->
427     <TR BGCOLOR='white' CLASS='TableRowColor'>
428     <TD>
429     <CODE><B><A HREF='ImageThumbnailWidget.html#is_last_page'>boolean is_last_page ( $offset )</A></B></CODE>
430     <BR>
431     <blockquote> Is thie offset for the last page? </blockquote>
432     </TD>
433     </TR>
434    
435     <!-- =========== Summary =========== -->
436     <TR BGCOLOR='white' CLASS='TableRowColor'>
437     <TD>
438     <CODE><B><A HREF='ImageThumbnailWidget.html#items_per_page'>int items_per_page ( )</A></B></CODE>
439     <BR>
440     <blockquote> Calculate the # of items on a page. </blockquote>
441     </TD>
442     </TR>
443    
444     <!-- =========== Summary =========== -->
445     <TR BGCOLOR='white' CLASS='TableRowColor'>
446     <TD>
447     <CODE><B><A HREF='ImageThumbnailWidget.html#item_index'>int item_index ( $offset )</A></B></CODE>
448     <BR>
449     <blockquote> Calculate the item # for the offset. </blockquote>
450     </TD>
451     </TR>
452    
453     <!-- =========== Summary =========== -->
454     <TR BGCOLOR='white' CLASS='TableRowColor'>
455     <TD>
456     <CODE><B><A HREF='ImageThumbnailWidget.html#num_items_on_page'>int num_items_on_page ( $offset )</A></B></CODE>
457     <BR>
458     <blockquote> Calculate the # of items
459     to on a particular page. </blockquote>
460     </TD>
461     </TR>
462    
463     <!-- =========== Summary =========== -->
464     <TR BGCOLOR='white' CLASS='TableRowColor'>
465     <TD>
466     <CODE><B><A HREF='ImageThumbnailWidget.html#num_pages'>int num_pages ( )</A></B></CODE>
467     <BR>
468     <blockquote> Calculate the number of
469     pages possible for this
470     list of thumbnails. </blockquote>
471     </TD>
472     </TR>
473    
474     <!-- =========== Summary =========== -->
475     <TR BGCOLOR='white' CLASS='TableRowColor'>
476     <TD>
477     <CODE><B><A HREF='ImageThumbnailWidget.html#offset'>int offset ( )</A></B></CODE>
478     <BR>
479     <blockquote> Get the current value of the offset var </blockquote>
480     </TD>
481     </TR>
482    
483     <!-- =========== Summary =========== -->
484     <TR BGCOLOR='white' CLASS='TableRowColor'>
485     <TD>
486     <CODE><B><A HREF='ImageThumbnailWidget.html#push'>void push ( $url, $text, [$selected = FALSE] )</A></B></CODE>
487     <BR>
488     <blockquote> </blockquote>
489     </TD>
490     </TR>
491    
492     <!-- =========== Summary =========== -->
493     <TR BGCOLOR='white' CLASS='TableRowColor'>
494     <TD>
495     <CODE><B><A HREF='ImageThumbnailWidget.html#push_blank'>void push_blank ( [$num = 1] )</A></B></CODE>
496     <BR>
497     <blockquote> </blockquote>
498     </TD>
499     </TR>
500    
501     <!-- =========== Summary =========== -->
502     <TR BGCOLOR='white' CLASS='TableRowColor'>
503     <TD>
504     <CODE><B><A HREF='ImageThumbnailWidget.html#push_text'>void push_text ( $text, [$selected = FALSE] )</A></B></CODE>
505     <BR>
506     <blockquote> </blockquote>
507     </TD>
508     </TR>
509    
510     <!-- =========== Summary =========== -->
511     <TR BGCOLOR='white' CLASS='TableRowColor'>
512     <TD>
513     <CODE><B><A HREF='ImageThumbnailWidget.html#render'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE>
514     <BR>
515     <blockquote> Render the entire widget. </blockquote>
516     </TD>
517     </TR>
518    
519     <!-- =========== Summary =========== -->
520     <TR BGCOLOR='white' CLASS='TableRowColor'>
521     <TD>
522     <CODE><B><A HREF='ImageThumbnailWidget.html#rows_per_page'>int rows_per_page ( )</A></B></CODE>
523     <BR>
524     <blockquote> Calculates the # of rows
525     per page possible. </blockquote>
526     </TD>
527     </TR>
528    
529     <!-- =========== Summary =========== -->
530     <TR BGCOLOR='white' CLASS='TableRowColor'>
531     <TD>
532     <CODE><B><A HREF='ImageThumbnailWidget.html#set_cols'>void set_cols ( $cols )</A></B></CODE>
533     <BR>
534     <blockquote> set how many columns the user wants
535     to display per row of thumbnails. </blockquote>
536     </TD>
537     </TR>
538    
539     <!-- =========== Summary =========== -->
540     <TR BGCOLOR='white' CLASS='TableRowColor'>
541     <TD>
542     <CODE><B><A HREF='ImageThumbnailWidget.html#set_filedir'>void set_filedir ( $dir )</A></B></CODE>
543     <BR>
544     <blockquote> Set the full path on disk where
545     the images live. </blockquote>
546     </TD>
547     </TR>
548    
549     <!-- =========== Summary =========== -->
550     <TR BGCOLOR='white' CLASS='TableRowColor'>
551     <TD>
552     <CODE><B><A HREF='ImageThumbnailWidget.html#set_global_prefix'>void set_global_prefix ( $prefix )</A></B></CODE>
553     <BR>
554     <blockquote> This function sets a prefix for all
555     variables that are used in the item list
556     table on a page. </blockquote>
557     </TD>
558     </TR>
559    
560     <!-- =========== Summary =========== -->
561     <TR BGCOLOR='white' CLASS='TableRowColor'>
562     <TD>
563     <CODE><B><A HREF='ImageThumbnailWidget.html#set_maxthumbs_per_page'>void set_maxthumbs_per_page ( [$num = 10] )</A></B></CODE>
564     <BR>
565     <blockquote> set how many thumbnails to display
566     per page. </blockquote>
567     </TD>
568     </TR>
569    
570     <!-- =========== Summary =========== -->
571     <TR BGCOLOR='white' CLASS='TableRowColor'>
572     <TD>
573     <CODE><B><A HREF='ImageThumbnailWidget.html#set_thumbnail_dimensions'>void set_thumbnail_dimensions ( [$width = 50], [$height = 50] )</A></B></CODE>
574     <BR>
575     <blockquote> Sets all thumnail dimensions. </blockquote>
576     </TD>
577     </TR>
578    
579     <!-- =========== Summary =========== -->
580     <TR BGCOLOR='white' CLASS='TableRowColor'>
581     <TD>
582     <CODE><B><A HREF='ImageThumbnailWidget.html#set_thumbnail_script'>void set_thumbnail_script ( $script )</A></B></CODE>
583     <BR>
584     <blockquote> Set the url for the thumbnail generation
585     script. </blockquote>
586     </TD>
587     </TR>
588    
589     <!-- =========== Summary =========== -->
590     <TR BGCOLOR='white' CLASS='TableRowColor'>
591     <TD>
592     <CODE><B><A HREF='ImageThumbnailWidget.html#set_urldir'>void set_urldir ( $dir )</A></B></CODE>
593     <BR>
594     <blockquote> Set the base url path where the files
595     live on the web site. </blockquote>
596     </TD>
597     </TR>
598    
599     <!-- =========== Summary =========== -->
600     <TR BGCOLOR='white' CLASS='TableRowColor'>
601     <TD>
602     <CODE><B><A HREF='ImageThumbnailWidget.html#strip_offset'>void strip_offset ( $query_string )</A></B></CODE>
603     <BR>
604     <blockquote> This function strips the offset </blockquote>
605     </TD>
606     </TR>
607    
608     <!-- =========== Summary =========== -->
609     <TR BGCOLOR='white' CLASS='TableRowColor'>
610     <TD>
611     <CODE><B><A HREF='ImageThumbnailWidget.html#test_maxthumbs_per_page'>void test_maxthumbs_per_page ( )</A></B></CODE>
612     <BR>
613     <blockquote> Make sure the maxthumbsperpage
614     isn't &gt; then total items. </blockquote>
615     </TD>
616     </TR>
617    
618     <!-- =========== Summary =========== -->
619     <TR BGCOLOR='white' CLASS='TableRowColor'>
620     <TD>
621     <CODE><B><A HREF='ImageThumbnailWidget.html#total_items'>int total_items ( )</A></B></CODE>
622     <BR>
623     <blockquote> returns the total # of
624     items we have to display. </blockquote>
625     </TD>
626     </TR>
627    
628     <!-- =========== Summary =========== -->
629     <TR BGCOLOR='white' CLASS='TableRowColor'>
630     <TD>
631     <CODE><B><A HREF='ImageThumbnailWidget.html#write_thumb_to_disk'>void write_thumb_to_disk ( $file, &$img, $type )</A></B></CODE>
632     <BR>
633     <blockquote> write the image to disk. </blockquote>
634     </TD>
635     </TR>
636    
637     <!-- =========== Summary =========== -->
638     <TR BGCOLOR='white' CLASS='TableRowColor'>
639     <TD>
640     <CODE><B><A HREF='ImageThumbnailWidget.html#_create_thumbnail_cache_dir'>void _create_thumbnail_cache_dir ( )</A></B></CODE>
641     <BR>
642     <blockquote> Try and create the thumbnail cache dir. </blockquote>
643     </TD>
644     </TR>
645    
646     <!-- =========== Summary =========== -->
647     <TR BGCOLOR='white' CLASS='TableRowColor'>
648     <TD>
649     <CODE><B><A HREF='ImageThumbnailWidget.html#_get_file_type'>void _get_file_type ( $file )</A></B></CODE>
650     <BR>
651     <blockquote> discover the type of image based off of the extension </blockquote>
652     </TD>
653     </TR>
654    
655     </TABLE>
656    
657     <hr>
658     <!-- ============ VARIABLE DETAIL =========== -->
659    
660     <A NAME='variable_detail'></A>
661     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
662     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
663     <TD>
664     <span CLASS="font12bold">Variable Detail</span>
665     <A HREF="#top" CLASS="links">^TOP</A>
666     </TD>
667     </TR>
668     </TABLE>
669    
670    
671     <A NAME='$_columns'><!-- --></A><H3>$_columns</H3>
672     <b>Data type:</b> mixed<br>
673     <!-- ========== Info from phpDoc block ========= -->
674     The number of columns for a
675     page.
676     <BR>
677    
678    
679     <UL>
680    
681     </UL>
682    
683     <HR>
684    
685     <A NAME='$_global_prefix'><!-- --></A><H3>$_global_prefix</H3>
686     <b>Data type:</b> mixed<br>
687     <!-- ========== Info from phpDoc block ========= -->
688     holds the prefix for all variables
689     <BR>
690     that are added to a url,
691     so we can possibly have more
692     then 1 of these per page.
693    
694     <UL>
695    
696     </UL>
697    
698     <HR>
699    
700     <A NAME='$_offsetVar'><!-- --></A><H3>$_offsetVar</H3>
701     <b>Data type:</b> mixed<br>
702     <!-- ========== Info from phpDoc block ========= -->
703     Holds the name of the offset
704     variable.
705     <BR>
706     It's prefixed w/
707     the _global_prefix var.
708    
709     <UL>
710    
711     </UL>
712    
713     <HR>
714    
715     <A NAME='$_supported_image_types'><!-- --></A><H3>$_supported_image_types</H3>
716     <b>Data type:</b> mixed<br>
717     <!-- ========== Info from phpDoc block ========= -->
718     Array of supported image
719     type flags.
720     <BR>
721    
722    
723     <UL>
724    
725     </UL>
726    
727     <HR>
728    
729    
730     <hr>
731     <!-- ============ FUNCTION DETAIL =========== -->
732    
733     <A NAME='function_detail'></A>
734     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
735     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
736     <TD>
737     <span class="font12bold">Method Detail</span>
738     <A HREF="#top" CLASS="links">^TOP</A>
739     </TD>
740     </TR>
741     </TABLE>
742     <BR>
743    
744     <DIV CLASS="function">
745     <A NAME='constructor ImageThumbnailWidget'><!-- --></A>
746     <SPAN CLASS="font12bold">constructor ImageThumbnailWidget</SPAN>
747     <BR>
748     <SPAN CLASS="font10bold">Useage : </SPAN>
749     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
750     <span class="font10bold" style="color: #0000FF">constructor ImageThumbnailWidget ( [$width = 760], [$cols = 5], [$filedir = NULL], [$urldir = NULL] )</SPAN>
751     <BR>
752    
753     <BR>
754     <SPAN CLASS="font10bold">Description : </SPAN>
755     <!-- ========== Info from phpDoc block ========= -->
756     Constructor for this class
757     It just sets the width for the
758     widget.
759     <BR>
760    
761     <DL>
762     <DT class="font10bold">Function Parameters:</DT>
763    
764     <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>
765    
766     <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
767     the default is 5.</DD>
768    
769    
770     <DT class="font10bold">Function Info:</DT>
771    
772     </DL>
773    
774     </DIV>
775     <BR>
776    
777     <DIV CLASS="function">
778     <A NAME='build_filelist'><!-- --></A>
779     <SPAN CLASS="font12bold">build_filelist</SPAN>
780     <BR>
781     <SPAN CLASS="font10bold">Useage : </SPAN>
782     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
783     <span class="font10bold" style="color: #0000FF">build_filelist ( )</SPAN>
784     <BR>
785    
786     <BR>
787     <SPAN CLASS="font10bold">Description : </SPAN>
788     <!-- ========== Info from phpDoc block ========= -->
789     build the list of images
790     <BR>
791     from a directory on disk
792     <DL>
793     <DT class="font10bold">Function Parameters:</DT>
794    
795    
796     <DT class="font10bold">Function Info:</DT>
797    
798     </DL>
799    
800     </DIV>
801     <BR>
802    
803     <DIV CLASS="function">
804     <A NAME='build_link_td'><!-- --></A>
805     <SPAN CLASS="font12bold">build_link_td</SPAN>
806     <BR>
807     <SPAN CLASS="font10bold">Useage : </SPAN>
808     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
809     <span class="font10bold" style="color: #0000FF">build_link_td ( $file )</SPAN>
810     <BR>
811    
812     <BR>
813     <SPAN CLASS="font10bold">Description : </SPAN>
814     <!-- ========== Info from phpDoc block ========= -->
815     build the link td.
816     <BR>
817    
818     <DL>
819     <DT class="font10bold">Function Parameters:</DT>
820    
821    
822     <DT class="font10bold">Function Info:</DT>
823    
824     </DL>
825    
826     </DIV>
827     <BR>
828    
829     <DIV CLASS="function">
830     <A NAME='build_page_control'><!-- --></A>
831     <SPAN CLASS="font12bold">build_page_control</SPAN>
832     <BR>
833     <SPAN CLASS="font10bold">Useage : </SPAN>
834     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
835     <span class="font10bold" style="color: #0000FF">build_page_control ( )</SPAN>
836     <BR>
837    
838     <BR>
839     <SPAN CLASS="font10bold">Description : </SPAN>
840     <!-- ========== Info from phpDoc block ========= -->
841    
842     <BR>
843    
844     <DL>
845     <DT class="font10bold">Function Parameters:</DT>
846    
847    
848     <DT class="font10bold">Function Info:</DT>
849    
850     </DL>
851    
852     </DIV>
853     <BR>
854    
855     <DIV CLASS="function">
856     <A NAME='build_thumbnails'><!-- --></A>
857     <SPAN CLASS="font12bold">build_thumbnails</SPAN>
858     <BR>
859     <SPAN CLASS="font10bold">Useage : </SPAN>
860     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
861     <span class="font10bold" style="color: #0000FF">build_thumbnails ( )</SPAN>
862     <BR>
863    
864     <BR>
865     <SPAN CLASS="font10bold">Description : </SPAN>
866     <!-- ========== Info from phpDoc block ========= -->
867     this function builds a cache dir of thumbnails, so we
868     don't have to render thumbnails every time we hit the
869     thumbnails page.
870     <BR>
871    
872     <DL>
873     <DT class="font10bold">Function Parameters:</DT>
874    
875    
876     <DT class="font10bold">Function Info:</DT>
877    
878     </DL>
879    
880     </DIV>
881     <BR>
882    
883     <DIV CLASS="function">
884     <A NAME='build_thumbnail_file'><!-- --></A>
885     <SPAN CLASS="font12bold">build_thumbnail_file</SPAN>
886     <BR>
887     <SPAN CLASS="font10bold">Useage : </SPAN>
888     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
889     <span class="font10bold" style="color: #0000FF">build_thumbnail_file ( $file )</SPAN>
890     <BR>
891    
892     <BR>
893     <SPAN CLASS="font10bold">Description : </SPAN>
894     <!-- ========== Info from phpDoc block ========= -->
895     Builds a thumbnail version of a file,
896     and writes it to disk.
897     <BR>
898    
899     <DL>
900     <DT class="font10bold">Function Parameters:</DT>
901    
902     <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>
903    
904    
905     <DT class="font10bold">Function Info:</DT>
906    
907     </DL>
908    
909     </DIV>
910     <BR>
911    
912     <DIV CLASS="function">
913     <A NAME='build_thumb_table'><!-- --></A>
914     <SPAN CLASS="font12bold">build_thumb_table</SPAN>
915     <BR>
916     <SPAN CLASS="font10bold">Useage : </SPAN>
917     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
918     <span class="font10bold" style="color: #0000FF">build_thumb_table ( )</SPAN>
919     <BR>
920    
921     <BR>
922     <SPAN CLASS="font10bold">Description : </SPAN>
923     <!-- ========== Info from phpDoc block ========= -->
924     function that will render the widget.
925     <BR>
926     child class should override this.
927     <DL>
928     <DT class="font10bold">Function Parameters:</DT>
929    
930    
931     <DT class="font10bold">Function Info:</DT>
932    
933     </DL>
934    
935     </DIV>
936     <BR>
937    
938     <DIV CLASS="function">
939     <A NAME='getdirlist'><!-- --></A>
940     <SPAN CLASS="font12bold">getdirlist</SPAN>
941     <BR>
942     <SPAN CLASS="font10bold">Useage : </SPAN>
943     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
944     <span class="font10bold" style="color: #0000FF">getdirlist ( $dir )</SPAN>
945     <BR>
946    
947     <BR>
948     <SPAN CLASS="font10bold">Description : </SPAN>
949     <!-- ========== Info from phpDoc block ========= -->
950    
951     <BR>
952    
953     <DL>
954     <DT class="font10bold">Function Parameters:</DT>
955    
956    
957     <DT class="font10bold">Function Info:</DT>
958    
959     </DL>
960    
961     </DIV>
962     <BR>
963    
964     <DIV CLASS="function">
965     <A NAME='get_supported_image_formats'><!-- --></A>
966     <SPAN CLASS="font12bold">get_supported_image_formats</SPAN>
967     <BR>
968     <SPAN CLASS="font10bold">Useage : </SPAN>
969     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
970     <span class="font10bold" style="color: #0000FF">get_supported_image_formats ( )</SPAN>
971     <BR>
972    
973     <BR>
974     <SPAN CLASS="font10bold">Description : </SPAN>
975     <!-- ========== Info from phpDoc block ========= -->
976     This tests to see what type of gd
977     lib image format this server supports.
978     <BR>
979    
980     <DL>
981     <DT class="font10bold">Function Parameters:</DT>
982    
983    
984     <DT class="font10bold">Function Info:</DT>
985    
986     </DL>
987    
988     </DIV>
989     <BR>
990    
991     <DIV CLASS="function">
992     <A NAME='is_last_page'><!-- --></A>
993     <SPAN CLASS="font12bold">is_last_page</SPAN>
994     <BR>
995     <SPAN CLASS="font10bold">Useage : </SPAN>
996     <span class="font10bold" style="color: #FF0000">boolean</SPAN>&nbsp;
997     <span class="font10bold" style="color: #0000FF">is_last_page ( $offset )</SPAN>
998     <BR>
999    
1000     <BR>
1001     <SPAN CLASS="font10bold">Description : </SPAN>
1002     <!-- ========== Info from phpDoc block ========= -->
1003     Is thie offset for the last page?
1004     <BR>
1005    
1006     <DL>
1007     <DT class="font10bold">Function Parameters:</DT>
1008    
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">$offset</SPAN></SPAN> - page offset</DD>
1010    
1011    
1012     <DT class="font10bold">Function Info:</DT>
1013    
1014     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - TRUE:FALSE</DD>
1015    
1016     </DL>
1017    
1018     </DIV>
1019     <BR>
1020    
1021     <DIV CLASS="function">
1022     <A NAME='items_per_page'><!-- --></A>
1023     <SPAN CLASS="font12bold">items_per_page</SPAN>
1024     <BR>
1025     <SPAN CLASS="font10bold">Useage : </SPAN>
1026     <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
1027     <span class="font10bold" style="color: #0000FF">items_per_page ( )</SPAN>
1028     <BR>
1029    
1030     <BR>
1031     <SPAN CLASS="font10bold">Description : </SPAN>
1032     <!-- ========== Info from phpDoc block ========= -->
1033     Calculate the # of items on a page.
1034     <BR>
1035    
1036     <DL>
1037     <DT class="font10bold">Function Parameters:</DT>
1038    
1039    
1040     <DT class="font10bold">Function Info:</DT>
1041    
1042     </DL>
1043    
1044     </DIV>
1045     <BR>
1046    
1047     <DIV CLASS="function">
1048     <A NAME='item_index'><!-- --></A>
1049     <SPAN CLASS="font12bold">item_index</SPAN>
1050     <BR>
1051     <SPAN CLASS="font10bold">Useage : </SPAN>
1052     <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
1053     <span class="font10bold" style="color: #0000FF">item_index ( $offset )</SPAN>
1054     <BR>
1055    
1056     <BR>
1057     <SPAN CLASS="font10bold">Description : </SPAN>
1058     <!-- ========== Info from phpDoc block ========= -->
1059     Calculate the item # for the offset.
1060     <BR>
1061    
1062     <DL>
1063     <DT class="font10bold">Function Parameters:</DT>
1064    
1065    
1066     <DT class="font10bold">Function Info:</DT>
1067    
1068     </DL>
1069    
1070     </DIV>
1071     <BR>
1072    
1073     <DIV CLASS="function">
1074     <A NAME='num_items_on_page'><!-- --></A>
1075     <SPAN CLASS="font12bold">num_items_on_page</SPAN>
1076     <BR>
1077     <SPAN CLASS="font10bold">Useage : </SPAN>
1078     <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
1079     <span class="font10bold" style="color: #0000FF">num_items_on_page ( $offset )</SPAN>
1080     <BR>
1081    
1082     <BR>
1083     <SPAN CLASS="font10bold">Description : </SPAN>
1084     <!-- ========== Info from phpDoc block ========= -->
1085     Calculate the # of items
1086     to on a particular page.
1087     <BR>
1088    
1089     <DL>
1090     <DT class="font10bold">Function Parameters:</DT>
1091    
1092     <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>
1093    
1094    
1095     <DT class="font10bold">Function Info:</DT>
1096    
1097     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - # of items on offset's page.</DD>
1098    
1099     </DL>
1100    
1101     </DIV>
1102     <BR>
1103    
1104     <DIV CLASS="function">
1105     <A NAME='num_pages'><!-- --></A>
1106     <SPAN CLASS="font12bold">num_pages</SPAN>
1107     <BR>
1108     <SPAN CLASS="font10bold">Useage : </SPAN>
1109     <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
1110     <span class="font10bold" style="color: #0000FF">num_pages ( )</SPAN>
1111     <BR>
1112    
1113     <BR>
1114     <SPAN CLASS="font10bold">Description : </SPAN>
1115     <!-- ========== Info from phpDoc block ========= -->
1116     Calculate the number of
1117     pages possible for this
1118     list of thumbnails.
1119     <BR>
1120     It depends
1121     on the # of columns, and the
1122     max thumbs per page, and the total.
1123     <DL>
1124     <DT class="font10bold">Function Parameters:</DT>
1125    
1126    
1127     <DT class="font10bold">Function Info:</DT>
1128    
1129     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - # of pages.</DD>
1130    
1131     </DL>
1132    
1133     </DIV>
1134     <BR>
1135    
1136     <DIV CLASS="function">
1137     <A NAME='offset'><!-- --></A>
1138     <SPAN CLASS="font12bold">offset</SPAN>
1139     <BR>
1140     <SPAN CLASS="font10bold">Useage : </SPAN>
1141     <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
1142     <span class="font10bold" style="color: #0000FF">offset ( )</SPAN>
1143     <BR>
1144    
1145     <BR>
1146     <SPAN CLASS="font10bold">Description : </SPAN>
1147     <!-- ========== Info from phpDoc block ========= -->
1148     Get the current value of the offset var
1149     <BR>
1150    
1151     <DL>
1152     <DT class="font10bold">Function Parameters:</DT>
1153    
1154    
1155     <DT class="font10bold">Function Info:</DT>
1156    
1157     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the page offset</DD>
1158    
1159     </DL>
1160    
1161     </DIV>
1162     <BR>
1163    
1164     <DIV CLASS="function">
1165     <A NAME='push'><!-- --></A>
1166     <SPAN CLASS="font12bold">push</SPAN>
1167     <BR>
1168     <SPAN CLASS="font10bold">Useage : </SPAN>
1169     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1170     <span class="font10bold" style="color: #0000FF">push ( $url, $text, [$selected = FALSE] )</SPAN>
1171     <BR>
1172    
1173     <BR>
1174     <SPAN CLASS="font10bold">Description : </SPAN>
1175     <!-- ========== Info from phpDoc block ========= -->
1176    
1177     <BR>
1178    
1179     <DL>
1180     <DT class="font10bold">Function Parameters:</DT>
1181    
1182    
1183     <DT class="font10bold">Function Info:</DT>
1184    
1185     </DL>
1186    
1187     </DIV>
1188     <BR>
1189    
1190     <DIV CLASS="function">
1191     <A NAME='push_blank'><!-- --></A>
1192     <SPAN CLASS="font12bold">push_blank</SPAN>
1193     <BR>
1194     <SPAN CLASS="font10bold">Useage : </SPAN>
1195     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1196     <span class="font10bold" style="color: #0000FF">push_blank ( [$num = 1] )</SPAN>
1197     <BR>
1198    
1199     <BR>
1200     <SPAN CLASS="font10bold">Description : </SPAN>
1201     <!-- ========== Info from phpDoc block ========= -->
1202    
1203     <BR>
1204    
1205     <DL>
1206     <DT class="font10bold">Function Parameters:</DT>
1207    
1208    
1209     <DT class="font10bold">Function Info:</DT>
1210    
1211     </DL>
1212    
1213     </DIV>
1214     <BR>
1215    
1216     <DIV CLASS="function">
1217     <A NAME='push_text'><!-- --></A>
1218     <SPAN CLASS="font12bold">push_text</SPAN>
1219     <BR>
1220     <SPAN CLASS="font10bold">Useage : </SPAN>
1221     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1222     <span class="font10bold" style="color: #0000FF">push_text ( $text, [$selected = FALSE] )</SPAN>
1223     <BR>
1224    
1225     <BR>
1226     <SPAN CLASS="font10bold">Description : </SPAN>
1227     <!-- ========== Info from phpDoc block ========= -->
1228    
1229     <BR>
1230    
1231     <DL>
1232     <DT class="font10bold">Function Parameters:</DT>
1233    
1234    
1235     <DT class="font10bold">Function Info:</DT>
1236    
1237     </DL>
1238    
1239     </DIV>
1240     <BR>
1241    
1242     <DIV CLASS="function">
1243     <A NAME='render'><!-- --></A>
1244     <SPAN CLASS="font12bold">render</SPAN>
1245     <BR>
1246     <SPAN CLASS="font10bold">Useage : </SPAN>
1247     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
1248     <span class="font10bold" style="color: #0000FF">render ( [$indent_level = 1], [$output_debug = 0] )</SPAN>
1249     <BR>
1250    
1251     <BR>
1252     <SPAN CLASS="font10bold">Description : </SPAN>
1253     <!-- ========== Info from phpDoc block ========= -->
1254     Render the entire widget.
1255     <BR>
1256     this includes the
1257     page offset links, as well as the thumbnails.
1258     <DL>
1259     <DT class="font10bold">Function Parameters:</DT>
1260    
1261     <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
1262     the container.</DD>
1263    
1264     <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
1265     maintain compatibility w/ the API.</DD>
1266    
1267    
1268     <DT class="font10bold">Function Info:</DT>
1269    
1270     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw html output.</DD>
1271    
1272     </DL>
1273    
1274     </DIV>
1275     <BR>
1276    
1277     <DIV CLASS="function">
1278     <A NAME='rows_per_page'><!-- --></A>
1279     <SPAN CLASS="font12bold">rows_per_page</SPAN>
1280     <BR>
1281     <SPAN CLASS="font10bold">Useage : </SPAN>
1282     <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
1283     <span class="font10bold" style="color: #0000FF">rows_per_page ( )</SPAN>
1284     <BR>
1285    
1286     <BR>
1287     <SPAN CLASS="font10bold">Description : </SPAN>
1288     <!-- ========== Info from phpDoc block ========= -->
1289     Calculates the # of rows
1290     per page possible.
1291     <BR>
1292    
1293     <DL>
1294     <DT class="font10bold">Function Parameters:</DT>
1295    
1296    
1297     <DT class="font10bold">Function Info:</DT>
1298    
1299     </DL>
1300    
1301     </DIV>
1302     <BR>
1303    
1304     <DIV CLASS="function">
1305     <A NAME='set_cols'><!-- --></A>
1306     <SPAN CLASS="font12bold">set_cols</SPAN>
1307     <BR>
1308     <SPAN CLASS="font10bold">Useage : </SPAN>
1309     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1310     <span class="font10bold" style="color: #0000FF">set_cols ( $cols )</SPAN>
1311     <BR>
1312    
1313     <BR>
1314     <SPAN CLASS="font10bold">Description : </SPAN>
1315     <!-- ========== Info from phpDoc block ========= -->
1316     set how many columns the user wants
1317     to display per row of thumbnails.
1318     <BR>
1319    
1320     <DL>
1321     <DT class="font10bold">Function Parameters:</DT>
1322    
1323    
1324     <DT class="font10bold">Function Info:</DT>
1325    
1326     </DL>
1327    
1328     </DIV>
1329     <BR>
1330    
1331     <DIV CLASS="function">
1332     <A NAME='set_filedir'><!-- --></A>
1333     <SPAN CLASS="font12bold">set_filedir</SPAN>
1334     <BR>
1335     <SPAN CLASS="font10bold">Useage : </SPAN>
1336     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1337     <span class="font10bold" style="color: #0000FF">set_filedir ( $dir )</SPAN>
1338     <BR>
1339    
1340     <BR>
1341     <SPAN CLASS="font10bold">Description : </SPAN>
1342     <!-- ========== Info from phpDoc block ========= -->
1343     Set the full path on disk where
1344     the images live.
1345     <BR>
1346    
1347     <DL>
1348     <DT class="font10bold">Function Parameters:</DT>
1349    
1350    
1351     <DT class="font10bold">Function Info:</DT>
1352    
1353     </DL>
1354    
1355     </DIV>
1356     <BR>
1357    
1358     <DIV CLASS="function">
1359     <A NAME='set_global_prefix'><!-- --></A>
1360     <SPAN CLASS="font12bold">set_global_prefix</SPAN>
1361     <BR>
1362     <SPAN CLASS="font10bold">Useage : </SPAN>
1363     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1364     <span class="font10bold" style="color: #0000FF">set_global_prefix ( $prefix )</SPAN>
1365     <BR>
1366    
1367     <BR>
1368     <SPAN CLASS="font10bold">Description : </SPAN>
1369     <!-- ========== Info from phpDoc block ========= -->
1370     This function sets a prefix for all
1371     variables that are used in the item list
1372     table on a page.
1373     <BR>
1374     This allows you to have
1375     multiple itemlists on a single html page.
1376     <DL>
1377     <DT class="font10bold">Function Parameters:</DT>
1378    
1379     <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>
1380    
1381    
1382     <DT class="font10bold">Function Info:</DT>
1383    
1384     </DL>
1385    
1386     </DIV>
1387     <BR>
1388    
1389     <DIV CLASS="function">
1390     <A NAME='set_maxthumbs_per_page'><!-- --></A>
1391     <SPAN CLASS="font12bold">set_maxthumbs_per_page</SPAN>
1392     <BR>
1393     <SPAN CLASS="font10bold">Useage : </SPAN>
1394     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1395     <span class="font10bold" style="color: #0000FF">set_maxthumbs_per_page ( [$num = 10] )</SPAN>
1396     <BR>
1397    
1398     <BR>
1399     <SPAN CLASS="font10bold">Description : </SPAN>
1400     <!-- ========== Info from phpDoc block ========= -->
1401     set how many thumbnails to display
1402     per page.
1403     <BR>
1404    
1405     <DL>
1406     <DT class="font10bold">Function Parameters:</DT>
1407    
1408    
1409     <DT class="font10bold">Function Info:</DT>
1410    
1411     </DL>
1412    
1413     </DIV>
1414     <BR>
1415    
1416     <DIV CLASS="function">
1417     <A NAME='set_thumbnail_dimensions'><!-- --></A>
1418     <SPAN CLASS="font12bold">set_thumbnail_dimensions</SPAN>
1419     <BR>
1420     <SPAN CLASS="font10bold">Useage : </SPAN>
1421     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1422     <span class="font10bold" style="color: #0000FF">set_thumbnail_dimensions ( [$width = 50], [$height = 50] )</SPAN>
1423     <BR>
1424    
1425     <BR>
1426     <SPAN CLASS="font10bold">Description : </SPAN>
1427     <!-- ========== Info from phpDoc block ========= -->
1428     Sets all thumnail dimensions.
1429     <BR>
1430    
1431     <DL>
1432     <DT class="font10bold">Function Parameters:</DT>
1433    
1434     <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>
1435    
1436     <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>
1437    
1438    
1439     <DT class="font10bold">Function Info:</DT>
1440    
1441     </DL>
1442    
1443     </DIV>
1444     <BR>
1445    
1446     <DIV CLASS="function">
1447     <A NAME='set_thumbnail_script'><!-- --></A>
1448     <SPAN CLASS="font12bold">set_thumbnail_script</SPAN>
1449     <BR>
1450     <SPAN CLASS="font10bold">Useage : </SPAN>
1451     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1452     <span class="font10bold" style="color: #0000FF">set_thumbnail_script ( $script )</SPAN>
1453     <BR>
1454    
1455     <BR>
1456     <SPAN CLASS="font10bold">Description : </SPAN>
1457     <!-- ========== Info from phpDoc block ========= -->
1458     Set the url for the thumbnail generation
1459     script.
1460     <BR>
1461    
1462     <DL>
1463     <DT class="font10bold">Function Parameters:</DT>
1464    
1465    
1466     <DT class="font10bold">Function Info:</DT>
1467    
1468     </DL>
1469    
1470     </DIV>
1471     <BR>
1472    
1473     <DIV CLASS="function">
1474     <A NAME='set_urldir'><!-- --></A>
1475     <SPAN CLASS="font12bold">set_urldir</SPAN>
1476     <BR>
1477     <SPAN CLASS="font10bold">Useage : </SPAN>
1478     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1479     <span class="font10bold" style="color: #0000FF">set_urldir ( $dir )</SPAN>
1480     <BR>
1481    
1482     <BR>
1483     <SPAN CLASS="font10bold">Description : </SPAN>
1484     <!-- ========== Info from phpDoc block ========= -->
1485     Set the base url path where the files
1486     live on the web site.
1487     <BR>
1488    
1489     <DL>
1490     <DT class="font10bold">Function Parameters:</DT>
1491    
1492    
1493     <DT class="font10bold">Function Info:</DT>
1494    
1495     </DL>
1496    
1497     </DIV>
1498     <BR>
1499    
1500     <DIV CLASS="function">
1501     <A NAME='strip_offset'><!-- --></A>
1502     <SPAN CLASS="font12bold">strip_offset</SPAN>
1503     <BR>
1504     <SPAN CLASS="font10bold">Useage : </SPAN>
1505     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1506     <span class="font10bold" style="color: #0000FF">strip_offset ( $query_string )</SPAN>
1507     <BR>
1508    
1509     <BR>
1510     <SPAN CLASS="font10bold">Description : </SPAN>
1511     <!-- ========== Info from phpDoc block ========= -->
1512     This function strips the offset
1513     <BR>
1514    
1515     <DL>
1516     <DT class="font10bold">Function Parameters:</DT>
1517    
1518    
1519     <DT class="font10bold">Function Info:</DT>
1520    
1521     </DL>
1522    
1523     </DIV>
1524     <BR>
1525    
1526     <DIV CLASS="function">
1527     <A NAME='test_maxthumbs_per_page'><!-- --></A>
1528     <SPAN CLASS="font12bold">test_maxthumbs_per_page</SPAN>
1529     <BR>
1530     <SPAN CLASS="font10bold">Useage : </SPAN>
1531     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1532     <span class="font10bold" style="color: #0000FF">test_maxthumbs_per_page ( )</SPAN>
1533     <BR>
1534    
1535     <BR>
1536     <SPAN CLASS="font10bold">Description : </SPAN>
1537     <!-- ========== Info from phpDoc block ========= -->
1538     Make sure the maxthumbsperpage
1539     isn't &gt; then total items.
1540     <BR>
1541    
1542     <DL>
1543     <DT class="font10bold">Function Parameters:</DT>
1544    
1545    
1546     <DT class="font10bold">Function Info:</DT>
1547    
1548     </DL>
1549    
1550     </DIV>
1551     <BR>
1552    
1553     <DIV CLASS="function">
1554     <A NAME='total_items'><!-- --></A>
1555     <SPAN CLASS="font12bold">total_items</SPAN>
1556     <BR>
1557     <SPAN CLASS="font10bold">Useage : </SPAN>
1558     <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
1559     <span class="font10bold" style="color: #0000FF">total_items ( )</SPAN>
1560     <BR>
1561    
1562     <BR>
1563     <SPAN CLASS="font10bold">Description : </SPAN>
1564     <!-- ========== Info from phpDoc block ========= -->
1565     returns the total # of
1566     items we have to display.
1567     <BR>
1568    
1569     <DL>
1570     <DT class="font10bold">Function Parameters:</DT>
1571    
1572    
1573     <DT class="font10bold">Function Info:</DT>
1574    
1575     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - total items.</DD>
1576    
1577     </DL>
1578    
1579     </DIV>
1580     <BR>
1581    
1582     <DIV CLASS="function">
1583     <A NAME='write_thumb_to_disk'><!-- --></A>
1584     <SPAN CLASS="font12bold">write_thumb_to_disk</SPAN>
1585     <BR>
1586     <SPAN CLASS="font10bold">Useage : </SPAN>
1587     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1588     <span class="font10bold" style="color: #0000FF">write_thumb_to_disk ( $file, &$img, $type )</SPAN>
1589     <BR>
1590    
1591     <BR>
1592     <SPAN CLASS="font10bold">Description : </SPAN>
1593     <!-- ========== Info from phpDoc block ========= -->
1594     write the image to disk.
1595     <BR>
1596     We assume we have write permissions
1597     to the images dir.
1598     <DL>
1599     <DT class="font10bold">Function Parameters:</DT>
1600    
1601    
1602     <DT class="font10bold">Function Info:</DT>
1603    
1604     </DL>
1605    
1606     </DIV>
1607     <BR>
1608    
1609     <DIV CLASS="function">
1610     <A NAME='_create_thumbnail_cache_dir'><!-- --></A>
1611     <SPAN CLASS="font12bold">_create_thumbnail_cache_dir</SPAN>
1612     <BR>
1613     <SPAN CLASS="font10bold">Useage : </SPAN>
1614     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1615     <span class="font10bold" style="color: #0000FF">_create_thumbnail_cache_dir ( )</SPAN>
1616     <BR>
1617    
1618     <BR>
1619     <SPAN CLASS="font10bold">Description : </SPAN>
1620     <!-- ========== Info from phpDoc block ========= -->
1621     Try and create the thumbnail cache dir.
1622     <BR>
1623    
1624     <DL>
1625     <DT class="font10bold">Function Parameters:</DT>
1626    
1627    
1628     <DT class="font10bold">Function Info:</DT>
1629    
1630     </DL>
1631    
1632     </DIV>
1633     <BR>
1634    
1635     <DIV CLASS="function">
1636     <A NAME='_get_file_type'><!-- --></A>
1637     <SPAN CLASS="font12bold">_get_file_type</SPAN>
1638     <BR>
1639     <SPAN CLASS="font10bold">Useage : </SPAN>
1640     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1641     <span class="font10bold" style="color: #0000FF">_get_file_type ( $file )</SPAN>
1642     <BR>
1643    
1644     <BR>
1645     <SPAN CLASS="font10bold">Description : </SPAN>
1646     <!-- ========== Info from phpDoc block ========= -->
1647     discover the type of image based off of the extension
1648     <BR>
1649    
1650     <DL>
1651     <DT class="font10bold">Function Parameters:</DT>
1652    
1653     <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>
1654    
1655    
1656     <DT class="font10bold">Function Info:</DT>
1657    
1658     </DL>
1659    
1660     </DIV>
1661     <BR>
1662    
1663    
1664     <hr>
1665     </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed