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

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

Parent Directory Parent Directory | Revision Log Revision Log

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