Manuel - Label
Introduction
Cette classe permet d'ajouter du texte autour du code-barres en utilisant des caractéristiques spécifiques.
Méthodes
Méthodes de BCGLabel
-
__constructor__(
$text ,$font ,$position ,$alignment ) — Crée un texte avec les arguments par défaut ou spécifiques - getText() — Récupère le texte associé au label
-
setText(
$text ) — Spécifie le texte associé au label - getFont() — Récupère la police associé au label
-
setFont(
$font ) — Spécifie la police associée au label - getPosition() — Récupère la position associée au label
-
setPosition(
$position ) — Spécifie la position associé au label - getAlignment() — Récupère l'alignment associé au label
-
setAlignment(
$alignment ) — Spécifie l'alignement associé au label - getOffset() — Récupère le décalage associé au label
-
setOffset(
$offset ) — Spécifie le décalage associé au label - getSpacing() — Récupère l'espace associé au label
-
setSpacing(
$spacing ) — Spécifie l'espace associé au label - getRotationAngle() — Récupère l'angle de rotation associé au label
-
setRotationAngle(
$rotationAngle ) — Spécifie l'angle de rotation associé au label - getBackgroundColor() — Récupère la couleur de fond associée avec le label
-
setBackgroundColor(
$backgroundColor ) — Spécifie la couleur de fond associée avec le label - getDimension() — Récupère les dimensions du texte
-
draw(
$im ,$x1 ,$y1 ,$x2 ,$y2 ) — Dessine le texte sur l'image
Exemple de Code
// Pour obtenir un exemple de l'utilisation de cette classe, voyez une classe de code-barres.
Explications des Méthodes
-
__constructor__(
$text ,$font ,$position ,$alignment ) — Crée un texte avec les arguments par défaut ou spécifiquesDescriptionCrée la classe. Vous pouvez utiliser aucun argument pour créer le texte par défaut, ou spécifier les arguments à l'avance.
Voyez les méthodes appropriées pour plus d'informations. -
getText()
—
Récupère le texte associé au label
DescriptionRetourne le texte.Retourne
string -
setText(
$text ) — Spécifie le texte associé au labelDescriptionSpécifie le texte. -
getFont()
—
Récupère la police associé au label
DescriptionLa police implémente l'interface
BCGFont .RetourneBCGFont -
setFont(
$font ) — Spécifie la police associée au labelDescriptionSupporte deux sortes de police.
-BCGFontFile : Police TTF
-BCGFontPhp : Police intégrée à PHP
La valeur par défaut est BCGFontPhp(5). -
getPosition()
—
Récupère la position associée au label
DescriptionVoyez aussi setPosition() pour plus de détails.Retourne
int -
setPosition(
$position ) — Spécifie la position associé au labelDescriptionLes valeurs possibles pour cet argument sont :
BCGLabel::POSITION_TOP : Écrit le label en haut du code-barres
BCGLabel::POSITION_RIGHT : Écrit le label à droite du code-barres
BCGLabel::POSITION_BOTTOM : Écrit le label en bas du code-barres
BCGLabel::POSITION_LEFT : Écrit le label à gauche du code-barres
Notez que le texte ne sera pas pivoté par défaut si celui-ci est placé sur la gauche ou la droite. Afin de faire pivoter le code-barres, vous devez utiliser la méthodesetRotationAngle() .
La valeur par défaut estBCGLabel::POSITION_BOTTOM . -
getAlignment()
—
Récupère l'alignment associé au label
DescriptionVoyez aussi setAlignment() pour plus de détails.Retourne
int -
setAlignment(
$alignment ) — Spécifie l'alignement associé au labelDescriptionLes valeurs possibles pour cet argument sont :
BCGLabel::ALIGN_LEFT : Aligne le label sur la gauche du code-barres
BCGLabel::ALIGN_RIGHT : Aligne le label sur la droite du code-barres
BCGLabel::ALIGN_CENTER : Aligne le label au centre du code-barres
BCGLabel::ALIGN_TOP : Aligne le label sur le haut du code-barres
BCGLabel::ALIGN_BOTTOM : Aligne le label sur le bas du code-barres
UtilisezBCGLabel::ALIGN_LEFT etBCGLabel::ALIGN_RIGHT pour aligner sur la gauche ou droite, pour du texte positionné en haut ou en bas, indépendamment de l'angle de rotation. Par conséquent, utilisezBCGLabel::ALIGN_TOP etBCGLabel::ALIGN_BOTTOM pour aligner en haut ou bas, pour du texte positionné sur la gauche ou sur la droite.
La valeur par défaut estBCGLabel::ALIGN_CENTER . -
getOffset()
—
Récupère le décalage associé au label
DescriptionRécupère le décalage en pixel associé au label.Retourne
int -
setOffset(
$offset ) — Spécifie le décalage associé au labelDescriptionSpécifie le décalage en pixel associé au label.
Un décalage positif déplacera le texte vers la droite pour du texte positionné en haut ou en bas, et déplacera le texte vers le bas pour du texte positionné à gauche ou à droite.
Vous pouvez utiliser un chiffre négatif pour avoir le rendu inverse.
La valeur par défaut est 0. -
getSpacing()
—
Récupère l'espace associé au label
DescriptionRécupère l'espace entre le label et le code-barres en pixel.Retourne
int -
setSpacing(
$spacing ) — Spécifie l'espace associé au labelDescriptionSpécifie l'espace entre le label et le code-barres en pixel.
Pour un texte positionné en haut ou en bas, ceci est la distance entre la partie du bas et la partie du haut du texte.
Pour un texte positionné à gauche et à droite, ceci est la distance entre la partie du droite et la partie gauche du texte.
La valeur par défaut est 4. -
getRotationAngle()
—
Récupère l'angle de rotation associé au label
DescriptionRécupère l'angle de rotation en degré dans le sens des aiguilles d'une montre.Retourne
int -
setRotationAngle(
$rotationAngle ) — Spécifie l'angle de rotation associé au labelDescriptionSpécifie l'angle de rotation en degré dans le sens des aiguilles d'une montre. Les valeurs possibles pour cet argument sont :
-0 : Par défaut, aucune rotation n'est appliquée
-90 : Pivote le texte 90° dans le sens des aiguilles d'une montre
-180 : Pivote le texte 180° dans le sens des aiguilles d'une montre
-270 : Pivote le texte 270° dans le sens des aiguilles d'une montre
La valeur par défaut est 0.
Notez que votre serveur peut ne pas supporter la fonction imagerotate(). -
getBackgroundColor()
—
Récupère la couleur de fond associée avec le label
DescriptionRécupère la couleur de fond.Retourne
-
setBackgroundColor(
$backgroundColor ) — Spécifie la couleur de fond associée avec le labelDescriptionSpécifie la couleur de fond, utillisée pour la rotation.
Cette méthode est interne; n'utilisez pas cette méthode directement. -
getDimension()
—
Récupère les dimensions du texte
DescriptionRécupère la largeur et la hauteur en pixel en fonction de la police et du texte entré.Retournearray(int, int) - [0] étant la largeur, [1] étant la hauteur
-
draw(
$im ,$x1 ,$y1 ,$x2 ,$y2 ) — Dessine le texte sur l'imageDescription$image est une image ressource.
Les arguments$x1 et$y1 correspondent à la position du coin supérieur gauche du code-barres.
Les arguments$x2 et$y2 correspondent à la position du coin inférieur droit du code-barres.