Manuel - Drawing

Introduction

Cette classe permet de dessiner le code-barres sur une image ressource. Vous pouvez bien sûr utiliser une autre classe pour dessiner le code-barres.

Méthodes

Méthodes de BCGDrawing

• __constructor__($barcode, $color) — Construit le dessin
• getImage() — Récupère l'image ressource
• setImage($image) — Spécifie l'image ressource
• getBarcode() — Retourne le code-barres associé
• setBarcode($barcode) — Spécifie le code-barres à utiliser
• getDpi() — Récupère le DPI pour le type de fichier
• setDpi($dpi) — Spécifie le DPI pour le type de fichier
• getRotationAngle() — Récupère l'angle de rotation en degré
• setRotationAngle($degree) — Spécifie l'angle de rotation en degré
• draw() — Dessine le code-barres sur l'image
• drawException($exception) — Dessine l'exception sur l'image ressource
• finish($imageStyle, $fileName) — Termine le dessin en l'enregistrant ou l'affichant
• destroy() — Détruit la mémoire associée à l'image

Exemple de Code

// Pour obtenir un exemple de l'utilisation de cette classe, voyez une classe de code-barres.

Explications des Méthodes

• __constructor__($barcode, $color) — Construit le dessin
  Description

  Crée la classe. Le premier argument doit être un code-barres de type BCGBarcode.
  Le deuxième argument est la couleur de fond du dessin. Cela doit être un objet BCGColor.
  Ces deux arguments sont optionnels.
• getImage() — Récupère l'image ressource
  Description

  Récupère l'image ressource pour effectuer d'autres opérations.
  Retourne

  ressource - image PHP
• setImage($image) — Spécifie l'image ressource
  Description

  Spécifie l'image ressource dans la classe. Cette image sera donc utilisée au lieu d'en créer une. Vous devez par contre avoir la bonne taille d'image en fonction de la taille retournée par la méthode du code-barres getDimension().
• getBarcode() — Retourne le code-barres associé
  Description

  Retourne le code-barres associé.
  Retourne

  BCGBarcode
• setBarcode($barcode) — Spécifie le code-barres à utiliser
  Description

  Spécifie le code-barres. La classe doit être un objet BCGBarcode.
• getDpi() — Récupère le DPI pour le type de fichier
  Description

  Récupère le DPI spéficié pour l'image. La valeur peut être null. Cela signifie que l'image sera écrite sans l'attribute DPI.
  Retourne

  int - DPI ou null
• setDpi($dpi) — Spécifie le DPI pour le type de fichier
  Description

  Spécifie le DPI pour l'image. Si vous ne spécifiez aucun DPI pour l'image, la valeur null est utilisée. L'utilisation de la valeur NULL améliore les performances lorsque l'image est générée. L'image résultante sera de 72DPI si vous ne spécifiez aucun DPI.
  Seuls les fichiers de type PNG and JPG supporte la configuration DPI.
• getRotationAngle() — Récupère l'angle de rotation en degré
  Description

  Retourne l'angle de rotation pour l'image en degré. (sens des aiguilles d'une montre)
  Retourne

  int - valeur entre 0 et 360
• setRotationAngle($degree) — Spécifie l'angle de rotation en degré
  Description

  Spécifie l'angle de rotation pour l'image en degré. (sans des aiguilles d'une montre)
  Notez que votre serveur peut ne pas supporter la fonction imagerotate().
• draw() — Dessine le code-barres sur l'image
  Description

  Dessine le code-barres sur l'image ressource. Si vous en n'avez pas spécifié avec la méthode setImage(), une nouvelle image sera créée.
• drawException($exception) — Dessine l'exception sur l'image ressource
  Description

  Dessine l'exception passée sur l'image ressource.
• finish($imageStyle, $fileName) — Termine le dessin en l'enregistrant ou l'affichant
  Description

  Écrit l'image dans le fichier spécifié ou à l'écran si le fichier n'est pas utilisé.
  Le premier argument $imageStyle peut prendre quatre différentes valeurs :
  - BCGDrawing::IMG_FORMAT_PNG : dessinera en format PNG
  - BCGDrawing::IMG_FORMAT_JPEG : dessinera en format JPG
  - BCGDrawing::IMG_FORMAT_GIF : dessinera en format GIF
  - BCGDrawing::IMG_FORMAT_WBMP : dessinera en format WBMP
  Le deuxième argument est le chemin du fichier si vous souhaitez sauvegarder l'image.
• destroy() — Détruit la mémoire associée à l'image
  Description

  Cette méthode est appelée automatiquement avec PHP5. Vous devez l'appeler par vous-même avec PHP4 ou l'image sera simplement détruite à la fin du script.