Version courante : 2.1.0
IntroductionLe code Aztec fait partie de la famille des codes barres en 2D. Il permet d'encoder beaucoup d'information en un seul code barre.
Tous les caractères ASCII de 0 à 255 sont supportés. La taille du code sera déterminée en fonction du nombre de données entrées ainsi que du niveau d'erreur choisi.
Il est possible de passer en mode ECI avec la fonction
setTilde().
Cette classe hérite de la classe
BCGBarcode2D.
Méthodes de BCGaztecMéthodes de BCGBarcode2DAucune méthode spécifique à cette classe.
Méthodes de BCGBarcodeExemple
<?php
require('BCGColor.php');
require('BCGDrawing.php');
require('BCGaztec.barcode2d.php');
$code = new BCGaztec();
$code->setScale(3);
$code->setErrorLevel(23);
$code->parse('Code 2D!');
$color_black = new BCGColor(0, 0, 0);
$color_white = new BCGColor(255, 255, 255);
$drawing = new BCGDrawing('', $color_white);
$drawing->setBarcode($code);
$drawing->draw();
header('Content-Type: image/png');
$drawing->finish(BCGDrawing::IMG_FORMAT_PNG);
?>
Explication des MéthodessetErrorLevel($level) — Fixe le niveau d'erreur du code barre
Description
Il s'agit du pourcentage de correction d'erreur défini avant de dessiner le code barre.
Le niveau donné doit être entre 0 et 99.
La valeur par défaut est 23.
setSize($value) — Fixe la taille du code barre
Description
La taille du code barre finale sera décidée automatiquement dépendamment du nombre de données
que vous avez spécifié ainsi que le pourcentage de correction d'erreur.
Cependant, vous pouvez spécifier différentes valeurs à cette méthode pour obtenir un code
différent. Voici les valeurs possibles :
- BCGaztec::AZTEC_SIZE_SMALLEST : Le code sera le plus petit possible
- BCGaztec::AZTEC_SIZE_COMPACT : Le code essaiera d'être compact s'il le peut
- BCGaztec::AZTEC_SIZE_FULL : Le code sera en mode full (avec la grille de référence)
La valeur par défaut est
BCGaztec::AZTEC_SIZE_SMALLEST.
setStructureAppend($snum, $st, $sname) — Spécifie que les données seront dispersées sur plusieurs codes barres
Description
Les données du code Aztec peuvent être séparées sur plusieurs codes barres.
Le premier argument est le numéro du code barre (commençant par 1), le deuxième argument est le nombre
total de code barre que vous avez. Le dernier argument est optionnel, il spécifie un identifiant
à votre groupe de code barre. Celui-ci doit rester le même pour chaque code barre.
Il est possible d'encoder sur 26 codes barres différents au maximum.
Retourne
true en cas de réussite, false en cas d'échec.
setTilde($accept) — Modifie le fonctionnement du caractère tilde ~
Description
En mettant
true à l'argument de cette méthode, les caractères tilde (ASCII 126 ~) seront pris
comme des caractères spéciaux. Voici les caractères spéciaux que vous pouvez écrire.
- ~~ : Écrit un simple tilde
- ~F : Écrit le caractère FNC1
- ~Exxxxxx : Écrit le caractère ECI xxxxxx avec x pouvant varier de 0 à 9.
La valeur par défaut est
true.
setRune($runeNumber) — Spécifie de dessiner un Rune
Description
À l'appel de la fonction
draw(), le Rune numéro
$runeNumber
sera dessiné à l'écran. Les Runes sont des symboles spéciaux.
Retourne
true en cas de réussite, false en cas d'échec.
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 code barre que vous utilisez.
Référez-vous à l'introduction du code barre pour obtenir plus d'informations.
draw($im) — Dessine le code barre 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
getMaxSize().
getMaxSize() — 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. 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 barre
Description
Retourne la taille du code barre. La veleur correspond à la "plus petite" unité exprimée en pixel.
Retourne
int - valeur en pixel
setScale($x) — Fixe la résolution du code barre
Description
Le code barre sera $x fois plus grand. Un pixel sera alors de taille $x par $x.
setForegroundColor($color) — Fixe la couleur du code barre
Description
La couleur des barres du code barre. 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.
setBackgroundColor($color) — Fixe la couleur du fond
Description
La couleur de fond du code barre. 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($fg, $bg) — Fixe la couleur du code barre et de fond
setOffsetX($v) — Spécifie le décalage en X
Description
Spécifie le décalage en X du code barre en pixel multiplié par l'échelle. La taille requise retournée par
getMaxSize() sera modifiée en conséquence.
setOffsetY($v) — Spécifie le décalage en Y
Description
Spécifie le décalage en Y du code barre en pixel multiplié par l'échelle. La taille requise retournée par
getMaxSize() sera modifiée en conséquence.