Manuel - BCGdatabarexpanded

Introduction

Databar Extended (précédemment RSS Expanded) encode les données basées sur le standard de l'organisation GS1. Faute de se conformer au standard peut produire un code-barres illisible.

Pour connaître les caractères supportés et les modes d'encodage, voyez la page aperçu.

Le code-barres est toujours composé d'un identifiant suivi d'une valeur. Puisque les parenthèses peuvent être une valeur possible, vous ne devez pas entourer l'identifiant de parenthèses.
Databar Extended peut contenir plusieurs identifiants. Si vous utilisez un identifiant de taille variable, vous devez terminer sa valeur par un caractère FNC1 à moins que la valeur termine le code-barres.

La hauteur minimale doit être de 34 pixels.

Liste des identifiants :

Cette classe hérite de la classe BCGBarcode1D.

Exemple

Méthodes de BCGdatabarexpanded

• getLinkageFlag() —‌ Récupère si le flag de liaison est activé
• setLinkageFlag($linkageFlag) —‌ Spécifie d'utiliser le flag de liaison
• setStacked($stackedRow) —‌ Spécifie le nombre de lignes désirées

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 la police du 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 checksum ajouté au code-barres
• setDisplayChecksum($display) —‌ Spécifie que le checksum 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($im) —‌ Dessine le code-barres sur l'image $im
• getDimension($w, $h) —‌ Retourne un tableau concernant la taille de l'image requise
• getScale() —‌ Retourne la résolution du code-barres
• setScale($x) —‌ Fixe la résolution du code-barres
• getForegroundColor() —‌ Retourne la couleur des espaces
• setForegroundColor($color) —‌ Fixe la couleur des espaces
• getBackgroundColor() —‌ Retourne la couleur des barres
• setBackgroundColor($color) —‌ Fixe la couleur des barres
• setColor($fg, $bg) —‌ Fixe la couleur du code-barres et des espaces
• getOffsetX() —‌ Retourne le décalage en X
• setOffsetX($v) —‌ Spécifie le décalage en X
• getOffsetY() —‌ Retourne le décalage en Y
• setOffsetY($v) —‌ Spécifie le décalage en Y
• addLabel($label) —‌ Ajoute un texte qui accompagne le graphique
• removeLabel($label) —‌ Supprime un texte qui accompagne le graphique
• clearLabels() —‌ Supprime les textes qui accompagnent le graphique

Exemple de Code

<?php
require('class/BCGFontFile.php');
require('class/BCGColor.php');
require('class/BCGDrawing.php');
require('class/BCGdatabarexpanded.barcode.php');
 
$font = new BCGFontFile('./class/font/Arial.ttf', 18);
$color_black = new BCGColor(0, 0, 0);
$color_white = new BCGColor(255, 255, 255);
 
// Barcode Part
$code = new BCGdatabarexpanded();
$code->setScale(2);
$code->setThickness(30);
$code->setForegroundColor($color_black);
$code->setBackgroundColor($color_white);
$code->setFont($font);
$code->parse('0190012345678908');
 
// Drawing Part
$drawing = new BCGDrawing('', $color_white);
$drawing->setBarcode($code);
$drawing->draw();
 
header('Content-Type: image/png');
 
$drawing->finish(BCGDrawing::IMG_FORMAT_PNG);
?>

Explication des Méthodes

• getLinkageFlag() — Récupère si le flag de liaison est activé
  Description

  Récupère si le flag de liaison est activé.
  Retourne

  bool
• setLinkageFlag($linkageFlag) — Spécifie d'utiliser le flag de liaison
  Description

  Spécifie d'utiliser le flag de liaison, il est utilisé en conjonction avec un code-barres UCC/EAN.
  Spécifier cette propriété à true ne changera pas la taille de votre code-barres.
  La valeur par défaut est false.
• setStacked($stackedRow) — Spécifie le nombre de lignes désirées
  Description

  Spécifie le nombre de lignes désirées. Le nombre maximal est 11.
  Certaines valeurs ne sont pas possible; si vous utilisez un encodage de taille fixe, le nombre maximal de lignes sera 2.
  Si le flag de liaison est activé, la taille du code-barres doit être au moins 102 pixels.
  La valeur par défaut est 1.
• 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.
  Cette valeur est multipliée par la résolution. Référez-vous à la méthode setScale().
  La valeur par défaut est 30.
• 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 la police du 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 pour le 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 l'argument peut être soit une instance de la classe BCGFontFile, 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 checksum 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 - checksum ajouté ou false s'il n'y a pas de checksum
• setDisplayChecksum($display) — Spécifie que le checksum soit ajouté au texte qui accompagne le code-barres
  Description

  Spécifier true ajoutera le checksum 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($im) — Dessine le code-barres sur l'image $im
  Description

  La valeur de l'argument $im doit être une ressource image GD2. La taille de l'image peut être définie avec la valeur reçue de getDimension().
• getDimension($w, $h) — 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 pixel
• setScale($x) — 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 espaces
  Description

  Retourne la couleur des espaces du code-barres.
  Retourne

  BCGColor
• setForegroundColor($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.
• getBackgroundColor() — Retourne la couleur des barres
  Description

  Retourne la couleur des barres du code-barres.
  Retourne

  BCGColor
• setBackgroundColor($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.
• setColor($fg, $bg) — Fixe la couleur du code-barres et des espaces
  Description

  Une méthode plus rapide pour fixer la couleur de premier plan et de dernier 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 pixel
• setOffsetX($v) — 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 pixel
• setOffsetY($v) — 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 graphique
  Description

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

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

  Supprime tous les objets BCGLabel du graphique.