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