Manuel - MaxiCode

PHP .NET Node.js

Introduction

Le code MaxiCode fait partie de la famille des codes-barres en 2D. Il permet d'encoder un nombre spécifique d'information à l'intérieur d'un seul symbole.
Tous les caractères ASCII de 0 à 255 sont supportés. MaxiCode 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 BCGmaxicode

Méthodes de BCGBarcode2D

Méthodes de BCGBarcode

Exemple de Code


<?php

use BarcodeBakery\Common\BCGColor;

use BarcodeBakery\Common\BCGDrawing;

use BarcodeBakery\Barcode\BCGmaxicode;



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

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



// Barcode Part

$code = new BCGmaxicode();

$code->setScale(3);

$code->setForegroundColor($colorBlack);

$code->setBackgroundColor($colorWhite);

$code->setMode(4);

$code->parse('Maxicode');



// 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 MaxiCode nécessite d'avoir une zone muette (quiet zone) autour de l'image. Vous pouvez cependant ne pas l'afficher.
    La valeur par défaut est true.
  • getMode() — Récupère le mode du code-barres
    Description
    Récupère le mode du code-barres.
    Retourne
    int
  • setMode($mode) — Spécifie le mode
    Description
    Spécifie le mode pour générer le code-barres. Vous pouvez utiliser un mode 2 à 6. Voyez la page information technique pour plus d'information.
    La valeur par défaut est 4.
  • setPrimaryMessage($serviceClass, $countryCode, $postalCode) — Spécifie le message primaire
    Description
    Spécifie le message primaire pour les modes 2 ou 3. Si vous utilisez cette méthode, vous pouvez utiliser la méthode parse() pour remplir le message secondaire. Si vous n'utilisez pas cette méthode pour les modes 2 ou 3, le code-barres essaiera d'extraire les données du message passé à la méthode parse().
    La classe de service doit être un nombre entre 0 et 999. Le code de pays doit être un code ISO 3166 entre 0 et 999. Le code postal doit être numérique seulement (mode 2), ou alphanumérique (mode 3).
    Spécifiez le $serviceClass à -1 pour réinitialiser le message primaire.
  • setAcceptECI($accept) — Spécifie d'accepter les codes ECI
    Description
    En mettant true à l'argument de cette méthode, les caractères antislash (ASCII 92 \) seront pris comme des caractères spéciaux. Voici les caractères spéciaux que vous pouvez écrire.
    - \\ : Écrit un simple antislash
    - \xxxxxx : Écrit le caractère ECI xxxxxx avec x pouvant varier de 0 à 9
    La valeur par défaut est false.
  • setStructuredAppend($snum, $st) — Spécifie que les données seront dispersées sur plusieurs codes-barres
    Description
    Les données du code MaxiCode peuvent être séparées sur plusieurs codes-barres.
    Le premier argument est le numéro du code-barres (commençant par 1), le deuxième argument est le nombre total de codes-barres que vous avez.
    Il est possible d'encoder sur 8 codes-barres différents au maximum.
    Retourne
    bool - true en cas de succès, false en cas d'échec
  • 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 protégée (protected).
  • 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 protégée (protected).
  • 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.