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