Manuel - Intelligent Mail

PHP

Introduction

Le code Postnet permet d'encoder des codes postaux des États-Unis en incluant un code de localisation.
Vous devez fournir le code de localisation avec la méthode setTrackingCode() avant d'appeler la méthode parse().
La méthode parse() prend le code postal en paramêtre.
Le code postal doit être une de ces valeurs :

  • 5 chiffres(ZIP Code)
  • 9 chiffres(ZIP Code + 4)
  • 11 chiffres(ZIP Code + 4 + 2 chiffres)

Cette classe hérite de la classe BCGBarcode1D.

Exemple

Méthodes

Méthodes de BCGintelligentmail

Méthodes de BCGBarcode1D

Méthodes de BCGBarcode

Exemple de Code


<?php

use BarcodeBakery\Common\BCGFontFile;

use BarcodeBakery\Common\BCGColor;

use BarcodeBakery\Common\BCGDrawing;

use BarcodeBakery\Barcode\BCGintelligentmail;



$font = new BCGFontFile(__DIR__ . '/font/Arial.ttf', 18);

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

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



// Barcode Part

$code = new BCGintelligentmail();

$code->setScale(2);

$code->setForegroundColor($colorBlack);

$code->setBackgroundColor($colorWhite);

$code->setFont($font);

$code->setTrackingCode('01', '234', '567094', '987654321');

$code->parse('98103');



// 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 Intelligent Mail 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.
  • setTrackingCode($barcodeIdentifier, $serviceTypeIdentifier, $mailerIdentifier, $serialNumber) — Spécifie le code de localisation
    Description
    Ajoute des informations au code-barres :
    - Identifiant Code-Barres : Assigné par USPS, encode l'identifiant pour le tri. 2 chiffres, le dernier chiffre doit être entre 0 et 4.
    - Type de Service : Assigné par USPS, type de service du courrier. 3 chiffres.
    - Identifiant de l'Envoyeur : Assigné par USPS comme étant l'identifiant unique pour identifier votre compagnie. 6 ou 9 chiffres.
    - Numéro de Série : Assigné par l'envoyeur pour identifier ou localiser de manière unique les objets envoyés. 9 chiffres si l'identifiant de l'envoyeur est 6 chiffres. 6 chiffres autrement.
  • 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.