Manuel - Barcode 1D

Introduction

Cette classe est une classe abstraite qui contient les méthodes de base pour réaliser des codes-barres en 1D seulement.

Cette classe hérite de la classe BCGBarcode.

Méthodes

Méthodes de BCGBarcode1D

• getThickness() — Retourne l'épaisseur du code-barres
• setThickness($thickness) — Spécifie l'épaisseur du code-barres
• getLabel() — Retourne le texte qui accompagne le code-barres
• setLabel($label) — Spécifie le texte qui accompagne le code-barres
• getFont() — Retourne la police du texte qui accompagne le code-barres
• setFont($font) — Spécifie la police du texte qui accompagne le code-barres
• getChecksum() — Retourne le chiffre de vérification ajouté au code-barres
• setDisplayChecksum($display) — Spécifie que le chiffre de vérification soit ajouté au texte qui accompagne le code-barres

Méthodes de BCGBarcode

• parse($text) — Analyse un message $text pour dessiner par la suite
• draw($image) — Dessine le code-barres sur l'image $image
• getDimension($width, $height) — Retourne un tableau concernant la taille de l'image requise
• getScale() — Retourne la résolution du code-barres
• setScale($scale) — Fixe la résolution du code-barres
• getForegroundColor() — Retourne la couleur des barres
• setForegroundColor($color) — Fixe la couleur des barres
• getBackgroundColor() — Retourne la couleur des espaces
• setBackgroundColor($color) — Fixe la couleur des espaces
• setColor($foregroundColor, $backgroundColor) — Fixe la couleur des barres et des espaces
• getOffsetX() — Retourne le décalage en X
• setOffsetX($value) — Spécifie le décalage en X
• getOffsetY() — Retourne le décalage en Y
• setOffsetY($value) — Spécifie le décalage en Y
• addLabel($label) — Ajoute un texte qui accompagne le dessin
• removeLabel($label) — Supprime un texte qui accompagne le dessin
• clearLabels() — Supprime les textes qui accompagnent le dessin

Exemple de Code

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

Explications des Méthodes

• getThickness() — Retourne l'épaisseur du code-barres
  Description

  L'épaisseur du code-barres est en pixel. La valeur n'est pas multipliée par la résolution.
  Retourne

  int - valeur en pixel
• setThickness($thickness) — Spécifie l'épaisseur du code-barres
  Description

  L'épaisseur du code-barres est en pixel. Il s'agit de la grandeur verticale.
• getLabel() — Retourne le texte qui accompagne le code-barres
  Description

  Retourne la vraie valeur qui serait affichée avec le code-barres. Vous devez avoir appelé la méthode parse() .
  Retourne

  string - valeur finale
• setLabel($label) — Spécifie le texte qui accompagne le code-barres
  Description

  Le texte sera écrit au dessous ou au dessus du code-barres dépendamment de celui-ci. Vous pouvez écrire la valeur spéciale BCGBarcode1D::AUTO_LABEL si vous souhaitez que le texte soit automatiquement choisi. Il sera alors la valeur du texte passé à la méthode parse().
• getFont() — Retourne la police du texte qui accompagne le code-barres
  Description

  Retourne la police du texte qui accompagne le code-barres.
  Retourne

  BCGFontFile, BCGFontPhp, ou int
• setFont($font) — Spécifie la police du texte qui accompagne le code-barres
  Description

  La valeur de cet argument peut soit être une instance de BCGFontFile class, BCGFontPhp, ou un chiffre de 1 à 5.
  Si vous utilisez un chiffre etre 1 et 5, la police de PHP est utilisée. Référez-vous au Manuel PHP.
• getChecksum() — Retourne le chiffre de vérification ajouté au code-barres
  Description

  Retourne la valeur qui sera ajoutée au texte qui accompagne le code-barres. Cette méthode doit être appelée après la méthode parse().
  Retourne

  int - chiffre de vérification ajouté ou false s'il n'y a pas de chiffre de vérification
• setDisplayChecksum($display) — Spécifie que le chiffre de vérification soit ajouté au texte qui accompagne le code-barres
  Description

  Spécifier true ajoutera le chiffre de vérification au texte qui accompagne le code-barres par défaut.
  La valeur par défaut est true.

• parse($text) — Analyse un message $text pour dessiner par la suite
  Description

  Les données que vous passez à l'argument $text doivent être supportées par le type de code-barres que vous utilisez.
  Référez-vous à l'introduction de chaque code-barres pour obtenir plus d'informations comment utiliser cette méthode pour chaque type de code-barres.
• draw($image) — Dessine le code-barres sur l'image $image
  Description

  La valeur de l'argument $image doit être une image ressource. La taille de l'image peut être définie avec la valeur reçue de getDimension().
• getDimension($width, $height) — Retourne un tableau concernant la taille de l'image requise
  Description

  Retourne un tableau dont le premier index est la largeur de l'image et le deuxième index est la hauteur de l'image.
  Les arguments sont utilisés pour spécifier le point de départ du dessin. Ils devraient être 0.
  La classe BCGDrawing utilise cette fonction pour créer la ressource d'image.
  Retourne

  array(int, int) - [0] étant la largeur, [1] étant la hauteur
• getScale() — Retourne la résolution du code-barres
  Description

  Retourne la taille du code-barres. La valeur correspond à la "plus petite" unité exprimée en pixel.
  Retourne

  int - valeur en pixels
• setScale($scale) — Fixe la résolution du code-barres
  Description

  Le code-barres sera $x fois plus grand. Un pixel sera alors de taille $x par $x.
• getForegroundColor() — Retourne la couleur des barres
  Description

  Retourne la couleur des barres du code-barres.
  Retourne

  BCGColor
• setForegroundColor($color) — Fixe la couleur des barres
  Description

  La couleur des barres du code-barres. Par défaut, la couleur est noire. L'argument peut être soit une classe BCGColor ou n'importe quel autre argument que la classe BCGColor peut accepter à son constructeur.
• getBackgroundColor() — Retourne la couleur des espaces
  Description

  Retourne la couleur des espaces du code-barres.
  Retourne

  BCGColor
• setBackgroundColor($color) — Fixe la couleur des espaces
  Description

  La couleur des espaces du code-barres. Par défaut, la couleur est blanche. L'argument peut être soit une classe BCGColor ou n'importe quel autre argument que la classe BCGColor peut accepter à son constructeur.
• setColor($foregroundColor, $backgroundColor) — Fixe la couleur des barres et des espaces
  Description

  Une méthode plus rapide pour fixer la couleur de premier plan et de l'arrière-plan. Référez-vous à setForegroundColor() et setBackgroundColor().
• getOffsetX() — Retourne le décalage en X
  Description

  Retourne le décalage en X en pixel. Cette valeur n'est pas multipliée par la résolution.
  Retourne

  int - valeur en pixels
• setOffsetX($value) — Spécifie le décalage en X
  Description

  Spécifie le décalage en X du code-barres en pixel multiplié par la résolution. La taille requise retournée par getDimension() sera modifiée en conséquence.
• getOffsetY() — Retourne le décalage en Y
  Description

  Retourne le décalage en Y en pixel. Cette valeur n'est pas multipliée par la résolution.
  Retourne

  int - valeur en pixels
• setOffsetY($value) — Spécifie le décalage en Y
  Description

  Spécifie le décalage en Y du code-barres en pixel multiplié par la résolution. La taille requise retournée par getDimension() sera modifiée en conséquence.
• addLabel($label) — Ajoute un texte qui accompagne le dessin
  Description

  Ajoute un objet BCGLabel au dessin.
• removeLabel($label) — Supprime un texte qui accompagne le dessin
  Description

  Supprime un objet BCGLabel spécifique du graphique.
• clearLabels() — Supprime les textes qui accompagnent le dessin
  Description

  Supprime tous les objets BCGLabel du dessin.