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 :

Méthodes et propriétés

  • const int JPEG := 1
  • const int PNG := 2
  • const int GIF := 3

Documentation

  • const int JPEG := 1
    Indique que l'image est au format JPEG.
  • const int PNG := 2
    Indique que l'image est au format PNG.
  • const int GIF := 3
    Indique que l'image est au format GIF.
  • public int $width
    La largeur de l'image en pixels.
  • public int $height
    La hauteur de l'image en pixels.
  • public Shadow $shadow
    L'ombre associée à l'image.
  • public Border $border
    La bordure associée à l'image.
  • protected int $format := Image::PNG
    Le format de l'image. Cela peut être Image::PNG ou Image::JPEG.
  • protected bool $antiAliasing := FALSE
    Doit-on utiliser l'anti aliasing sur cette image ?
  • protected resource $resource
    La ressource GD créée par PHP pour gérer l'image.
  • protected Driver $driver
    Représente un objet de la classe Driver qui sera utilisé pour dessiner toutes sortes de données sur cette image.
  • 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.
  • public __construct()
    Construit l'image.
  • 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.
  • public setSize(int $width, int $height)
    Permet de déterminer la taille de l'image à une largeur $width et une hauteur $height.
  • public setBackgroundColor(Color $color)
    Change la couleur de fond de l'image.
  • public setBackgroundGradient(Gradient $gradient)
    Change le dégradé de fond de l'image.
  • 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.
  • public setFormat(int $format)
    Change le format de l'image. La nouvelle valeur peut être Image::PNG, Image::JPEG ou Image::GIF.
  • 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.
  • 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".
  • 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().
  • public drawComponent(Component $component)
    Dessine le composant $component sur l'image.
  • 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().
  • 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.
  • public sendHeaders()
    • Disponible depuis Artichow 1.0.9
    Envoie l'en-tête HTTP correspondant au format de l'image.
  • 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.
  • 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/.