update docs to version 1.5
[phpfspot.git] / docs / phpfspot / PHPFSPOT_IMG.html
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3   <html xmlns="http://www.w3.org/1999/xhtml">
4                 <head>
5                         <!-- template designed by Marco Von Ballmoos -->
6                         <title>Docs For Class PHPFSPOT_IMG</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"><img src="../media/images/Class_logo.png"
13                                                                                                                 alt=" Class"
14                                                                                                                 title=" Class"
15                                                                                                                 style="vertical-align: middle"> PHPFSPOT_IMG</h2>
16
17 <a name="sec-description"></a>
18 <div class="info-box">
19         <div class="info-box-title">Description</div>
20         <div class="nav-bar">
21                                         <span class="disabled">Description</span> |
22                                                                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
23                                                 
24                                         </div>
25         <div class="info-box-body">
26                         <!-- ========== Info from phpDoc block ========= -->
27 <p class="short-description">PHPFSPOT_IMG class</p>
28 <p class="description"><p>handles phpfspot's photos. It will output either the photo binaries  or can also show error messages as a on-the-fly generated picture.</p></p>
29                 <p class="notes">
30                         Located in <a class="field" href="_phpfspot_img.php.html">/phpfspot_img.php</a> (line <span class="field">34</span>)
31                 </p>
32                 
33                                 
34                 <pre></pre>
35         
36                         </div>
37 </div>
38
39
40
41
42         <a name="sec-method-summary"></a>
43         <div class="info-box">
44                 <div class="info-box-title">Method Summary</span></div>
45                 <div class="nav-bar">
46                         <a href="#sec-description">Description</a> |
47                                                                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
48                 </div>
49                 <div class="info-box-body">                     
50                         <div class="method-summary">
51                                                                                                                                                                                                                                                                                                                                                                                                 <div class="method-definition">
52                                         <img src="../media/images/Constructor.png" alt=" "/>
53                                                                                         <span class="method-result">PHPFSPOT_IMG</span>
54                                                                                 <a href="#__construct" title="details" class="method-name">__construct</a>
55                                                                                 ()
56                                                                         </div>
57                                                                                                                                 <div class="method-definition">
58                                         <img src="../media/images/Destructor.png" alt=" "/>
59                                                                                         <span class="method-result">void</span>
60                                                                                 <a href="#__destruct" title="details" class="method-name">__destruct</a>
61                                                                                 ()
62                                                                         </div>
63                                                                                                                                 <div class="method-definition">
64                                         <img src="../media/images/Method.png" alt=" "/>
65                                                                                         <span class="method-result">void</span>
66                                                                                 <a href="#showImg" title="details" class="method-name">showImg</a>
67                                                                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">0</span>])
68                                                                         </div>
69                                                                                                                                 <div class="method-definition">
70                                         <img src="../media/images/Method.png" alt=" "/>
71                                                                                         <span class="method-result">void</span>
72                                                                                 <a href="#showTagImg" title="details" class="method-name">showTagImg</a>
73                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$tagidx</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
74                                                                         </div>
75                                                                                         </div>
76                 </div>
77         </div>          
78
79         
80         <a name="sec-methods"></a>
81         <div class="info-box">
82                 <div class="info-box-title">Methods</div>
83                 <div class="nav-bar">
84                         <a href="#sec-description">Description</a> |
85                                                                                                         <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
86                                                 
87                 </div>
88                 <div class="info-box-body">
89                         <A NAME='method_detail'></A>
90 <a name="method__construct" id="__construct"><!-- --></a>
91 <div class="evenrow">
92         
93         <div class="method-header">
94                 <img src="../media/images/Constructor.png" />
95                 <span class="method-title">Constructor __construct</span> (line <span class="line-number">42</span>)
96         </div> 
97         
98         <!-- ========== Info from phpDoc block ========= -->
99 <p class="short-description">PHPFSPOT_IMG class constructor</p>
100         <ul class="tags">
101                                 <li><span class="field">access:</span> public</li>
102                         </ul>
103         
104         <div class="method-signature">
105                 <span class="method-result">PHPFSPOT_IMG</span>
106                 <span class="method-name">
107                         __construct
108                 </span>
109                                 ()
110                         </div>
111         
112                 
113                         
114         </div>
115 <a name="method__destruct" id="__destruct"><!-- --></a>
116 <div class="oddrow">
117         
118         <div class="method-header">
119                 <img src="../media/images/Destructor.png" />
120                 <span class="method-title">Destructor __destruct</span> (line <span class="line-number">52</span>)
121         </div> 
122         
123         <!-- ========== Info from phpDoc block ========= -->
124 <p class="short-description">PHPFSPOT_IMG class destructor</p>
125         <ul class="tags">
126                                 <li><span class="field">access:</span> public</li>
127                         </ul>
128         
129         <div class="method-signature">
130                 <span class="method-result">void</span>
131                 <span class="method-name">
132                         __destruct
133                 </span>
134                                 ()
135                         </div>
136         
137                 
138                         
139         </div>
140 <a name="methodshowImg" id="showImg"><!-- --></a>
141 <div class="evenrow">
142         
143         <div class="method-header">
144                 <img src="../media/images/Method.png" />
145                 <span class="method-title">showImg</span> (line <span class="line-number">67</span>)
146         </div> 
147         
148         <!-- ========== Info from phpDoc block ========= -->
149 <p class="short-description">sends the specified image to the browser</p>
150 <p class="description"><p>this function will send the specified image to  the client - in the specified width. it also try's  to create on-the-fly missing thumbnails via PHPFSPOT  gen_thumbs function.</p></p>
151         <ul class="tags">
152                                 <li><span class="field">access:</span> public</li>
153                         </ul>
154         
155         <div class="method-signature">
156                 <span class="method-result">void</span>
157                 <span class="method-name">
158                         showImg
159                 </span>
160                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">0</span>])
161                         </div>
162         
163                         <ul class="parameters">
164                                         <li>
165                                 <span class="var-type">integer</span>
166                                 <span class="var-name">$idx</span>                      </li>
167                                         <li>
168                                 <span class="var-type">integer</span>
169                                 <span class="var-name">$width</span>                    </li>
170                                 </ul>
171                 
172                         
173         </div>
174 <a name="methodshowTagImg" id="showTagImg"><!-- --></a>
175 <div class="oddrow">
176         
177         <div class="method-header">
178                 <img src="../media/images/Method.png" />
179                 <span class="method-title">showTagImg</span> (line <span class="line-number">137</span>)
180         </div> 
181         
182         <!-- ========== Info from phpDoc block ========= -->
183 <p class="short-description">sends a random photo of the requested tag to the browser</p>
184 <p class="description"><p>this function will send a random photo to the client.  It is selected out by the provided $tagidx. It also try's  to create on-the-fly missing thumbnails via PHPFSPOT  gen_thumbs function.</p></p>
185         <ul class="tags">
186                                 <li><span class="field">access:</span> public</li>
187                         </ul>
188         
189         <div class="method-signature">
190                 <span class="method-result">void</span>
191                 <span class="method-name">
192                         showTagImg
193                 </span>
194                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$tagidx</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$idx</span>)
195                         </div>
196         
197                         <ul class="parameters">
198                                         <li>
199                                 <span class="var-type">integer</span>
200                                 <span class="var-name">$idx</span>                      </li>
201                                         <li>
202                                 <span class="var-type"></span>
203                                 <span class="var-name">$tagidx</span>                   </li>
204                                 </ul>
205                 
206                         
207         </div>
208                                                 
209                 </div>
210         </div>
211
212         
213         <p class="notes" id="credit">
214                 Documentation generated on Sun, 25 May 2008 10:46:41 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
215         </p>
216         </div></body>
217 </html>