Documentation

| ## abstract Class Image La classe Image 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. Les classes suivantes dérivent de Image : Graph FileImage Retourner voir la liste de toutes les classes ## Méthodes et propriétés const int JPEG := 1 const int PNG := 2 const int GIF := 3 public int $width public int $height public Shadow $shadow public Border $border protected int $format := Image::PNG protected bool $antiAliasing := FALSE protected resource $resource protected Driver $driver protected Color $background := new Color(255, 255, 255) public __construct() public Driver getDriver(int $w := 1, int $h := 1, int $x := 0.5, int $y := 0.5) public setSize(int $width, int $height) public setBackgroundColor(Color $color) public setBackgroundGradient(Gradient $gradient) public setAntiAliasing(bool $bool) public setFormat(int $format) public int getFormat() public string getFormatString() public create() public drawComponent(Component $component) public send() public resource get() public sendHeaders() public static drawError(string $message) public static drawErrorFile(string $error) ## Documentation const int JPEG := 1 Indique que l'image est au format JPEG. Remonter const int PNG := 2 Indique que l'image est au format PNG. Remonter const int GIF := 3 Indique que l'image est au format GIF. Remonter public int $width La largeur de l'image en pixels. Remonter public int $height La hauteur de l'image en pixels. Remonter public Shadow $shadow L'ombre associée à l'image. Remonter public Border $border La bordure associée à l'image. Remonter protected int $format := Image::PNG Le format de l'image. Cela peut être Image::PNG ou Image::JPEG. Remonter protected bool $antiAliasing := FALSE Doit-on utiliser l'anti aliasing sur cette image ? Remonter protected resource $resource La ressource GD créée par PHP pour gérer l'image. Remonter protected Driver $driver Représente un objet de la classe Driver qui sera utilisé pour dessiner toutes sortes de données sur cette image. Remonter protected Color $background := new Color(255, 255, 255) La couleur de fond de l'image. Par défaut, le fond d'une image est blanc. Remonter public __construct() Construit l'image. Remonter public Driver getDriver(int $w := 1, int $h := 1, int $x := 0.5, int $y := 0.5) Retourne un objet de type Driver qui permet de dessiner sur l'image. Le Driver aura une largeur $w et une hauteur $h, et son centre sera positionné au point ($x, $y). La largeur doit être comprise entre 0 et 1 et représente une fraction de la taille réelle de l'image. La position doit être elle aussi comprise entre 0 et 1. Les paramètres par défaut centrent le pilote au milieu de l'image et lui donnent la taille de l'image. Remonter public setSize(int $width, int $height) Permet de déterminer la taille de l'image à une largeur $width et une hauteur $height. Remonter public setBackgroundColor(Color $color) Change la couleur de fond de l'image. Remonter public setBackgroundGradient(Gradient $gradient) Change le dégradé de fond de l'image. Remonter public setAntiAliasing(bool $bool) Active ou désactive l'anti-aliasing sur l'image. L'anti-aliasing permet d'avoir des graphiques plus propres mais demande plus de ressources. L'anti-aliasing n'est pas activé par défaut. Voir aussi : Driver::setAntiAliasing() Remonter public setFormat(int $format) Change le format de l'image. La nouvelle valeur peut être Image::PNG, Image::JPEG ou Image::GIF. Remonter public int getFormat() Disponible depuis Artichow 1.1.0 Renvoie le format de l'image comme un entier. Les valeurs possibles sont Image::PNG, Image::JPEG ou Image::GIF. Remonter public string getFormatString() Disponible depuis Artichow 1.1.0 Renvoie le format de l'image comme une chaîne de caractères. Les valeurs possibles sont "jpeg", "png", ou "gif". Remonter public create() Créé l'image en vue d'y ajouter des composants. Il n'est possible de créer une image qu'après lui avoir affecté une taille avec setSize(). Remonter public drawComponent(Component $component) Dessine le composant $component sur l'image. Remonter public send() Construit l'image et l'envoie sur la sortie standard accompagnée des en-têtes HTTP correspondants. 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 get(). Pour sauvegarder l'image dans un fichier sur le disque, voyez la méthode Graph::draw(). Remonter public resource get() Disponible depuis Artichow 1.1.0 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. Remonter public sendHeaders() Disponible depuis Artichow 1.0.9 Envoie l'en-tête HTTP correspondant au format de l'image. Remonter public static drawError(string $message) Disponible depuis Artichow 1.0.8 Affiche une erreur de façon lisible sous forme graphique. string $message Le message d'erreur à afficher. Remonter public static drawErrorFile(string $error) Disponible depuis Artichow 1.0.8 Affiche une erreur à partir d'une image présente dans le dossier images/erreurs/. string $error Le nom de l'erreur à afficher. L'image correspondant à cette erreur sera récupérée dans le dossier images/erreurs/. Remonter |