Manuel - PDF417

PHP .NET Node.js

Introduction

Le code PDF417 fait partie de la famille des codes-barres en 2D. Il permet d'encoder beaucoup d'information en un seul code-barres.
Tous les caractères ASCII de 0 à 255 sont supportés. PDF417 encode les données différemment dépendamment du type de caractères fournis. Certains caractères sont encodés avec un plus grand taux de compression. Voyez le taux de compression sur la page technique.

Cette classe hérite de la classe BCGBarcode2D.

Exemple

Méthodes

Méthodes de BCGpdf417

Méthodes de BCGBarcode2D

Méthodes de BCGBarcode

Exemple de Code


<?php

use BarcodeBakery\Common\BCGColor;

use BarcodeBakery\Common\BCGDrawing;

use BarcodeBakery\Barcode\BCGpdf417;



$colorBlack = new BCGColor(0, 0, 0);

$colorWhite = new BCGColor(255, 255, 255);



// Barcode Part

$code = new BCGpdf417();

$code->setScale(3);

$code->setForegroundColor($colorBlack);

$code->setBackgroundColor($colorWhite);

$code->setErrorLevel(2);
$code->setCompact(false);
$code->setQuietZone(true);

$code->parse('PDF417');



// Drawing Part

$drawing = new BCGDrawing($code, $colorWhite);



header('Content-Type: image/png');



$drawing->finish(BCGDrawing::IMG_FORMAT_PNG);

?>

Explications des Méthodes

  • getQuietZone() — Retourne si la zone muette sera dessinée
    Retourne
    bool - true si activé, false autrement
  • setQuietZone($quietZone) — Spécifie de dessiner une zone muette autour du code-barres
    Description
    Pour être lu correctement, le PDF417 doit avoir une zone muette (quiet zone) autour de l'image. Vous pouvez cependant ne pas l'afficher.
    La valeur par défaut est true.
  • getCompact() — Retourne si le code-barres doit être au format tronqué
    Description
    Retourne si le code-barres doit être au format tronqué.
    Retourne
    bool - true si compact/tronqué
  • setCompact($compact) — Spécifie si le code-barres doit être au format tronqué
    Description
    Coupe le code-barres en enlevant les 2 dernières colonnes sur la droite. Votre code-barres se retrouve plus petit, par contre, il sera plus difficile de le lire.
    La valeur par défaut est false.
  • getColumn() — Retourne le nombre de colonnes de données
    Description
    Retourne le nombre de colonnes.
    Retourne
    int
  • setColumn($column) — Spécifie le nombre de colonnes de données
    Description
    Spécifie le nombre de colonnes de données que vous souhaitez écrire. Vous pouvez répartir vos données plus horizontalement que verticalement en modifiant ce paramètre.
    Le nombre de colonne doit être compris entre 1 et 30.
    En mettant -1, le nombre de colonnes est calculé automatiquement pour être le plus optimal possible.
    La valeur par défaut est -1.
  • getErrorLevel() — Retourne le niveau d'erreur du code-barres
    Description
    Retourne le niveau d'erreur.
    Retourne
    int
  • setErrorLevel($level) — Fixe le niveau d'erreur du code-barres
    Description
    Il s'agit du niveau d'erreur qui permettra la détection et la correction d'erreur dans le code-barres.
    Le niveau donné doit être entre 0 et 8.
    En mettant cette valeur, le niveau d'erreur est calculé automatiquement pour être le plus optimal possible.
    Le nombre de mot clés que vous pouvez écrire dans un seul code-barres dépend du niveau d'erreur. Voyez page technique pour plus de détails.
    La valeur par défaut est -1.
  • getRatio() — Retourne le ratio pour l'impression
    Description
    Retourne le ratio pour l'impression.
    Retourne
    int
  • setRatio($ratio) — Spécifie le ratio pour l'impression
    Description
    Spécifie le ratio pour l'impression. Ceci est utilisé seulement si le nombre de colonnes est choisi automatiquement puisque ce paramètre affecte le nombre de colonnes dans votre code-barres.
    Si le chiffre est inférieur à 1, le code-barres sera étendu plus à l'horizontal.
    La valeur par défaut est -1.
  • setScaleX($scaleX) — Spécifie la résolution du codes-barres en X
    Description
    La largeur en pixel d'un module.
    La valeur par défaut est 1.
    Notez que cette méthode est publique (public).
  • setScaleY($scaleY) — Spécifie la résolution du codes-barres en Y
    Description
    La hauteur en pixel d'un module.
    La valeur par défaut est 1.
    Notez que cette méthode est publique (public).
  • 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.