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