Subversion Repositories Applications.gtt

Rev

Rev 61 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
60 jpm 1 
<html>
2 
	<head>
3 
		<title>Documentation</title>
4 
		<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
5 
		<link rel='stylesheet' href='style.css' />
6 
	</head>
7 
 
8 
	<body>
9 
		<div align='center'>
10 
		<table cellpadding='0' cellspacing='0' id='contenu' class='round' style='width: 80%; margin-bottom: 20px'>
11 
			<tr>
12 
				<td class='borderhg'>&nbsp;</td>
13 
				<td class='borderh'>&nbsp;</td>
14 
				<td class='cornerhd'></td>
15 
			</tr>
16 
			<tr>
17 
				<td class='borderg'>&nbsp;</td>
18 
				<td><a id="top"></a><h2>
19 
<small>abstract</small> Class Image</h2><div class="description">
20 
		<p>
21 
			La classe <a href="Image.html">Image</a> est une classe abstraite à la base de toutes les images sur Artichow. Une image peut être copiée sur d'autres images et chaque image peut être générée soit au format PNG, soit au format JPEG.
22 
		</p>
23 
	</div><div class="inherit">
24 
			Les classes suivantes dérivent de Image :
25 
				<ul>
26 
<li><a href="Graph.html">Graph</a></li>
27 
<li><a href="FileImage.html">FileImage</a></li>
28 
</ul>
29 
</div><ul class="links"><li><a href="index.html">Retourner voir la liste de toutes les classes</a></li></ul><h2>Méthodes et propriétés</h2><ul class="constants">
30 
<li>
31 
<span class="access">const</span> <span class="type">int</span> <a href="Image.html#constant.JPEG">JPEG</a> := <span class="default">1</span>
32 
</li>
33 
<li>
34 
<span class="access">const</span> <span class="type">int</span> <a href="Image.html#constant.PNG">PNG</a> := <span class="default">2</span>
35 
</li>
36 
<li>
37 
<span class="access">const</span> <span class="type">int</span> <a href="Image.html#constant.GIF">GIF</a> := <span class="default">3</span>
38 
</li>
39 
</ul><ul class="properties">
40 
<li>
41 
<span class="access">public</span> <span class="type">int</span> <a href="Image.html#property.width"><span class="argument">$width</span></a>
42 
</li>
43 
<li>
44 
<span class="access">public</span> <span class="type">int</span> <a href="Image.html#property.height"><span class="argument">$height</span></a>
45 
</li>
46 
<li>
47 
<span class="access">public</span> <a href="Shadow.html"><span class="type">Shadow</span></a> <a href="Image.html#property.shadow"><span class="argument">$shadow</span></a>
48 
</li>
49 
<li>
50 
<span class="access">public</span> <a href="Border.html"><span class="type">Border</span></a> <a href="Image.html#property.border"><span class="argument">$border</span></a>
51 
</li>
52 
<li>
53 
<span class="access">protected</span> <span class="type">int</span> <a href="Image.html#property.format"><span class="argument">$format</span></a> := <span class="default">Image::PNG</span>
54 
</li>
55 
<li>
56 
<span class="access">protected</span> <span class="type">bool</span> <a href="Image.html#property.antiAliasing"><span class="argument">$antiAliasing</span></a> := <span class="default">FALSE</span>
57 
</li>
58 
<li>
59 
<span class="access">protected</span> <span class="type">resource</span> <a href="Image.html#property.resource"><span class="argument">$resource</span></a>
60 
</li>
61 
<li>
62 
<span class="access">protected</span> <a href="Driver.html"><span class="type">Driver</span></a> <a href="Image.html#property.driver"><span class="argument">$driver</span></a>
63 
</li>
64 
<li>
65 
<span class="access">protected</span> <a href="Color.html"><span class="type">Color</span></a> <a href="Image.html#property.background"><span class="argument">$background</span></a> := <span class="default">new Color(255, 255, 255)</span>
66 
</li>
67 
</ul><ul class="methods">
68 
<li>
69 
<span class="access">public</span> <a href="Image.html#method.__construct">__construct</a>()
70 
	</li>
71 
<li>
72 
<span class="access">public</span> <a href="Driver.html"><span class="type">Driver</span></a> <a href="Image.html#method.getDriver">getDriver</a>(<span class="type">int</span> <span class="argument">$w</span> := <span class="default">1</span>, <span class="type">int</span> <span class="argument">$h</span> := <span class="default">1</span>, <span class="type">int</span> <span class="argument">$x</span> := <span class="default">0.5</span>, <span class="type">int</span> <span class="argument">$y</span> := <span class="default">0.5</span>)
73 
	</li>
74 
<li>
75 
<span class="access">public</span> <a href="Image.html#method.setSize">setSize</a>(<span class="type">int</span> <span class="argument">$width</span>, <span class="type">int</span> <span class="argument">$height</span>)
76 
	</li>
77 
<li>
78 
<span class="access">public</span> <a href="Image.html#method.setBackgroundColor">setBackgroundColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
79 
	</li>
80 
<li>
81 
<span class="access">public</span> <a href="Image.html#method.setBackgroundGradient">setBackgroundGradient</a>(<a href="Gradient.html"><span class="type">Gradient</span></a> <span class="argument">$gradient</span>)
82 
	</li>
83 
<li>
84 
<span class="access">public</span> <a href="Image.html#method.setAntiAliasing">setAntiAliasing</a>(<span class="type">bool</span> <span class="argument">$bool</span>)
85 
	</li>
86 
<li>
87 
<span class="access">public</span> <a href="Image.html#method.setFormat">setFormat</a>(<span class="type">int</span> <span class="argument">$format</span>)
88 
	</li>
89 
<li>
90 
<span class="access">public</span> <span class="type">int</span> <a href="Image.html#method.getFormat">getFormat</a>()
91 
	</li>
92 
<li>
93 
<span class="access">public</span> <span class="type">string</span> <a href="Image.html#method.getFormatString">getFormatString</a>()
94 
	</li>
95 
<li>
96 
<span class="access">public</span> <a href="Image.html#method.create">create</a>()
97 
	</li>
98 
<li>
99 
<span class="access">public</span> <a href="Image.html#method.drawComponent">drawComponent</a>(<a href="Component.html"><span class="type">Component</span></a> <span class="argument">$component</span>)
100 
	</li>
101 
<li>
102 
<span class="access">public</span> <a href="Image.html#method.send">send</a>()
103 
	</li>
104 
<li>
105 
<span class="access">public</span> <span class="type">resource</span> <a href="Image.html#method.get">get</a>()
106 
	</li>
107 
<li>
108 
<span class="access">public</span> <a href="Image.html#method.sendHeaders">sendHeaders</a>()
109 
	</li>
110 
<li>
111 
<span class="access">public static</span> <a href="Image.html#method.drawError">drawError</a>(<span class="type">string</span> <span class="argument">
112 
							$message</span>)
113 
	</li>
114 
<li>
115 
<span class="access">public static</span> <a href="Image.html#method.drawErrorFile">drawErrorFile</a>(<span class="type">string</span> <span class="argument">
116 
							$error</span>)
117 
	</li>
118 
</ul><h2>Documentation</h2><ul class="doc">
119 
<li class="constant">
120 
<a id="constant.JPEG"></a><span class="access">const</span> <span class="type">int</span> <a href="Image.html#constant.JPEG">JPEG</a> := <span class="default">1</span><div class="description">
121 
				Indique que l'image est au format JPEG.
122 
			</div>
123 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
124 
</li>
125 
<li class="constant">
126 
<a id="constant.PNG"></a><span class="access">const</span> <span class="type">int</span> <a href="Image.html#constant.PNG">PNG</a> := <span class="default">2</span><div class="description">
127 
				Indique que l'image est au format PNG.
128 
			</div>
129 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
130 
</li>
131 
<li class="constant">
132 
<a id="constant.GIF"></a><span class="access">const</span> <span class="type">int</span> <a href="Image.html#constant.GIF">GIF</a> := <span class="default">3</span><div class="description">
133 
				Indique que l'image est au format GIF.
134 
			</div>
135 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
136 
</li>
137 
<li class="property">
138 
<a id="property.width"></a><span class="access">public</span> <span class="type">int</span> <a href="Image.html#property.width"><span class="argument">$width</span></a><div class="description">
139 
				La largeur de l'image en pixels.
140 
			</div>
141 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
142 
</li>
143 
<li class="property">
144 
<a id="property.height"></a><span class="access">public</span> <span class="type">int</span> <a href="Image.html#property.height"><span class="argument">$height</span></a><div class="description">
145 
				La hauteur de l'image en pixels.
146 
			</div>
147 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
148 
</li>
149 
<li class="property">
150 
<a id="property.shadow"></a><span class="access">public</span> <a href="Shadow.html"><span class="type">Shadow</span></a> <a href="Image.html#property.shadow"><span class="argument">$shadow</span></a><div class="description">
151 
				L'ombre associée à l'image.
152 
			</div>
153 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
154 
</li>
155 
<li class="property">
156 
<a id="property.border"></a><span class="access">public</span> <a href="Border.html"><span class="type">Border</span></a> <a href="Image.html#property.border"><span class="argument">$border</span></a><div class="description">
157 
				La bordure associée à l'image.
158 
			</div>
159 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
160 
</li>
161 
<li class="property">
162 
<a id="property.format"></a><span class="access">protected</span> <span class="type">int</span> <a href="Image.html#property.format"><span class="argument">$format</span></a> := <span class="default">Image::PNG</span><div class="description">
163 
				Le format de l'image. Cela peut être <a href="Image.html#constant.PNG">Image::PNG</a> ou <a href="Image.html#constant.JPEG">Image::JPEG</a>.
164 
			</div>
165 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
166 
</li>
167 
<li class="property">
168 
<a id="property.antiAliasing"></a><span class="access">protected</span> <span class="type">bool</span> <a href="Image.html#property.antiAliasing"><span class="argument">$antiAliasing</span></a> := <span class="default">FALSE</span><div class="description">
169 
				Doit-on utiliser l'anti aliasing sur cette image ?
170 
			</div>
171 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
172 
</li>
173 
<li class="property">
174 
<a id="property.resource"></a><span class="access">protected</span> <span class="type">resource</span> <a href="Image.html#property.resource"><span class="argument">$resource</span></a><div class="description">
175 
				La ressource GD créée par PHP pour gérer l'image.
176 
			</div>
177 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
178 
</li>
179 
<li class="property">
180 
<a id="property.driver"></a><span class="access">protected</span> <a href="Driver.html"><span class="type">Driver</span></a> <a href="Image.html#property.driver"><span class="argument">$driver</span></a><div class="description">
181 
				Représente un objet de la classe <a href="Driver.html">Driver</a> qui sera utilisé pour dessiner toutes sortes de données sur cette image.
182 
			</div>
183 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
184 
</li>
185 
<li class="property">
186 
<a id="property.background"></a><span class="access">protected</span> <a href="Color.html"><span class="type">Color</span></a> <a href="Image.html#property.background"><span class="argument">$background</span></a> := <span class="default">new Color(255, 255, 255)</span><div class="description">
187 
				La couleur de fond de l'image. Par défaut, le fond d'une image est blanc.
188 
			</div>
189 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
190 
</li>
191 
<li class="method">
192 
<a id="method.__construct"></a><span class="access">public</span> <a href="Image.html#method.__construct">__construct</a>()
193 
	<div class="description">
194 
				Construit l'image.
195 
			</div>
196 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
197 
</li>
198 
<li class="method">
199 
<a id="method.getDriver"></a><span class="access">public</span> <a href="Driver.html"><span class="type">Driver</span></a> <a href="Image.html#method.getDriver">getDriver</a>(<span class="type">int</span> <span class="argument">$w</span> := <span class="default">1</span>, <span class="type">int</span> <span class="argument">$h</span> := <span class="default">1</span>, <span class="type">int</span> <span class="argument">$x</span> := <span class="default">0.5</span>, <span class="type">int</span> <span class="argument">$y</span> := <span class="default">0.5</span>)
200 
	<div class="description">
201 
				Retourne un objet de type <a href="Driver.html">Driver</a> qui permet de dessiner sur l'image.
202 
				Le <a href="Driver.html">Driver</a> aura une largeur $w et une hauteur $h, et son centre sera positionné au point ($x, $y).
203 
				La largeur doit être comprise entre 0 et 1 et représente une fraction de la taille réelle de l'image.
204 
				La position doit être elle aussi comprise entre 0 et 1.
205 
				Les paramètres par défaut centrent le pilote au milieu de l'image et lui donnent la taille de l'image.
206 
			</div>
207 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
208 
</li>
209 
<li class="method">
210 
<a id="method.setSize"></a><span class="access">public</span> <a href="Image.html#method.setSize">setSize</a>(<span class="type">int</span> <span class="argument">$width</span>, <span class="type">int</span> <span class="argument">$height</span>)
211 
	<div class="description">
212 
				Permet de déterminer la taille de l'image à une largeur $width et une hauteur $height.
213 
			</div>
214 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
215 
</li>
216 
<li class="method">
217 
<a id="method.setBackgroundColor"></a><span class="access">public</span> <a href="Image.html#method.setBackgroundColor">setBackgroundColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
218 
	<div class="description">
219 
				Change la couleur de fond de l'image.
220 
			</div>
221 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
222 
</li>
223 
<li class="method">
224 
<a id="method.setBackgroundGradient"></a><span class="access">public</span> <a href="Image.html#method.setBackgroundGradient">setBackgroundGradient</a>(<a href="Gradient.html"><span class="type">Gradient</span></a> <span class="argument">$gradient</span>)
225 
	<div class="description">
226 
				Change le dégradé de fond de l'image.
227 
			</div>
228 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
229 
</li>
230 
<li class="method">
231 
<a id="method.setAntiAliasing"></a><span class="access">public</span> <a href="Image.html#method.setAntiAliasing">setAntiAliasing</a>(<span class="type">bool</span> <span class="argument">$bool</span>)
232 
	<div class="description">
233 
				Active ou désactive l'anti-aliasing sur l'image.
234 
				L'anti-aliasing permet d'avoir des graphiques plus propres mais demande plus de ressources.
235 
				L'anti-aliasing n'est pas activé par défaut.
236 
			<div class="see">
237 
					Voir aussi :
238 
					<ul><li><a href="Driver.html#method.setAntiAliasing">Driver::setAntiAliasing()</a></li></ul>
239 
</div>
240 
</div>
241 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
242 
</li>
243 
<li class="method">
244 
<a id="method.setFormat"></a><span class="access">public</span> <a href="Image.html#method.setFormat">setFormat</a>(<span class="type">int</span> <span class="argument">$format</span>)
245 
	<div class="description">
246 
				Change le format de l'image. La nouvelle valeur peut être <a href="Image.html#constant.PNG">Image::PNG</a>, <a href="Image.html#constant.JPEG">Image::JPEG</a> ou <a href="Image.html#constant.GIF">Image::GIF</a>.
247 
			</div>
248 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
249 
</li>
250 
<li class="method">
251 
<a id="method.getFormat"></a><span class="access">public</span> <span class="type">int</span> <a href="Image.html#method.getFormat">getFormat</a>()
252 
	<ul class="version"><li>
253 
						Disponible depuis Artichow 1.1.0</li></ul>
254 
<div class="description">
255 
				Renvoie le format de l'image comme un entier.
256 
				Les valeurs possibles sont <a href="Image.html#constant.PNG">Image::PNG</a>, <a href="Image.html#constant.JPEG">Image::JPEG</a> ou <a href="Image.html#constant.GIF">Image::GIF</a>.
257 
			</div>
258 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
259 
</li>
260 
<li class="method">
261 
<a id="method.getFormatString"></a><span class="access">public</span> <span class="type">string</span> <a href="Image.html#method.getFormatString">getFormatString</a>()
262 
	<ul class="version"><li>
263 
						Disponible depuis Artichow 1.1.0</li></ul>
264 
<div class="description">
265 
				Renvoie le format de l'image comme une chaîne de caractères.
266 
				Les valeurs possibles sont "jpeg", "png", ou "gif".
267 
			</div>
268 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
269 
</li>
270 
<li class="method">
271 
<a id="method.create"></a><span class="access">public</span> <a href="Image.html#method.create">create</a>()
272 
	<div class="description">
273 
				Créé l'image en vue d'y ajouter des composants.
274 
				Il n'est possible de créer une image qu'après lui avoir affecté une taille avec <a href="Image.html#method.setSize">setSize()</a>.
275 
			</div>
276 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
277 
</li>
278 
<li class="method">
279 
<a id="method.drawComponent"></a><span class="access">public</span> <a href="Image.html#method.drawComponent">drawComponent</a>(<a href="Component.html"><span class="type">Component</span></a> <span class="argument">$component</span>)
280 
	<div class="description">
281 
				Dessine le composant $component sur l'image.
282 
			</div>
283 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
284 
</li>
285 
<li class="method">
286 
<a id="method.send"></a><span class="access">public</span> <a href="Image.html#method.send">send</a>()
287 
	<div class="description">
288 
				Construit l'image et l'envoie sur la sortie standard accompagnée des en-têtes HTTP correspondants.
289 
				Cette fonction ne prend plus d'arguments depuis Artichow 1.1.0. Pour récupérer les données brutes de l'image, utilisez la méthode <a href="Image.html#method.get">get()</a>. Pour sauvegarder l'image dans un fichier sur le disque, voyez la méthode <a href="Graph.html#method.draw">Graph::draw()</a>.
290 
			</div>
291 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
292 
</li>
293 
<li class="method">
294 
<a id="method.get"></a><span class="access">public</span> <span class="type">resource</span> <a href="Image.html#method.get">get</a>()
295 
	<ul class="version"><li>
296 
						Disponible depuis Artichow 1.1.0</li></ul>
297 
<div class="description">
298 
				Construit l'image et la renvoie sous forme de données binaires. Vous pouvez donc la stocker dans une variable si vous voulez faire des manipulations spécifiques.
299 
			</div>
300 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
301 
</li>
302 
<li class="method">
303 
<a id="method.sendHeaders"></a><span class="access">public</span> <a href="Image.html#method.sendHeaders">sendHeaders</a>()
304 
	<ul class="version"><li>
305 
						Disponible depuis Artichow 1.0.9</li></ul>
306 
<div class="description">
307 
				Envoie l'en-tête HTTP correspondant au format de l'image.
308 
			</div>
309 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
310 
</li>
311 
<li class="method">
312 
<a id="method.drawError"></a><span class="access">public static</span> <a href="Image.html#method.drawError">drawError</a>(<span class="type">string</span> <span class="argument">
313 
							$message</span>)
314 
	<ul class="version"><li>
315 
						Disponible depuis Artichow 1.0.8</li></ul>
316 
<div class="description">
317 
				Affiche une erreur de façon lisible sous forme graphique.
318 
			</div>
319 
<ul class="arguments"><li class="property">
320 
<span class="type">string</span> <a href="Image.html#property.message"><span class="argument">$message</span></a><div class="description">
321 
						Le message d'erreur à afficher.
322 
					</div>
323 
</li></ul>
324 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
325 
</li>
326 
<li class="method">
327 
<a id="method.drawErrorFile"></a><span class="access">public static</span> <a href="Image.html#method.drawErrorFile">drawErrorFile</a>(<span class="type">string</span> <span class="argument">
328 
							$error</span>)
329 
	<ul class="version"><li>
330 
						Disponible depuis Artichow 1.0.8</li></ul>
331 
<div class="description">
332 
				Affiche une erreur à partir d'une image présente dans le dossier <em>images/erreurs/</em>.
333 
			</div>
334 
<ul class="arguments"><li class="property">
335 
<span class="type">string</span> <a href="Image.html#property.error"><span class="argument">$error</span></a><div class="description">
336 
						Le nom de l'erreur à afficher.
337 
						L'image correspondant à cette erreur sera récupérée dans le dossier <em>images/erreurs/</em>.
338 
					</div>
339 
</li></ul>
340 
<div class="description-bottom"><a href="Image.html#top">Remonter</a></div>
341 
</li>
342 
</ul>
343 
</td>
344 
				<td class='borderd'>&nbsp;</td>
345 
			</tr>
346 
			<tr>
347 
				<td class='cornerbg'></td>
348 
				<td class='borderb'>&nbsp;</td>
349 
				<td class='cornerbd'></td>
350 
			</tr>
351 
		</table>
352 
		</div>
353 
	</body>
354 
</html>