Téléchargement HeroQR - Téléchargement du code source HeroQR

HeroQR

Autres catégories

v1.0.3

Télécharger

Bibliothèque HeroQR

HeroQR est une bibliothèque PHP avancée et modulaire conçue pour simplifier la création, la personnalisation et la gestion des codes QR. Que vous ayez besoin d'un code QR de base ou d'un code hautement personnalisé avec des logos et des couleurs intégrés, HeroQR a ce qu'il vous faut.

Caractéristiques

Personnalisation inégalée :
- Ajustez la taille du logo et ajoutez des logos au code QR.
- Ajoutez des étiquettes avec une couleur, une taille, un alignement du texte et une marge personnalisables.
- Prise en charge de divers formats d'encodage tels que UTF-8 et d'autres formats standard.
- Changez la couleur du code QR ainsi que la couleur d'arrière-plan.
- Ajustez automatiquement la disposition et la marge du code QR.
Encodage de données multiformat : encodez sans effort des URL, du texte, des e-mails, des cartes de visite et des informations de paiement.
Validation des données : la bibliothèque prend en charge la validation de divers types de données, notamment l'URL, le texte, l'e-mail, le numéro de téléphone, l'IP et le Wi-Fi, garantissant ainsi l'exactitude des données d'entrée.
Options d'exportation flexibles : enregistrez les codes QR dans plusieurs formats, notamment PDF, SVG, PNG, binaire, GIF, EPS et WebP, garantissant la compatibilité avec différents projets.
Framework Ready : s'intègre parfaitement aux frameworks comme Laravel, ce qui en fait un choix parfait pour les applications modernes.

Installation

Utilisez Composer pour installer la bibliothèque. Assurez-vous également d'avoir activé et configuré l'extension GD si vous souhaitez générer des images.

composer require amirezaeb/ HeroQR

Commencer

1. Utilisation de base

Générez un code QR simple en quelques lignes de code :

Exemple :

HeroQRCoreQRCodeGenerator; $qrCodeManager = new QRCodeGenerator(); $qrCode = $qrCodeManager # Set the data to be encoded in the QR code ->setData('https://test.org') # Generate the QR code in PNG format ->generate('png') ; # Save the generated QR code to a file named 'qrcode.png' $qrCode->saveTo('qrcode'); ">

 require ' vendor/autoload.php ' ;

use HeroQR  Core  QRCodeGenerator ;

$ qrCodeManager = new QRCodeGenerator ();

$ qrCode = $ qrCodeManager
    # Set the data to be encoded in the QR code
    -> setData ( ' https://test.org ' ) 
    # Generate the QR code in PNG format
    -> generate ( ' png ' ) ;

# Save the generated QR code to a file named 'qrcode.png'
$ qrCode -> saveTo ( ' qrcode ' );

2. Personnalisation avancée

Personnalisez entièrement l'apparence et les fonctionnalités de votre code QR tout en assurant la validation des données :

Options de personnalisation : Vous pouvez modifier divers paramètres tels que la taille, la couleur, le logo et d'autres aspects visuels.
Validation automatique des données : En utilisant DataType (facultatif), la bibliothèque valide automatiquement le type de données en cours d'encodage (Url, Email, Téléphone, Localisation, Wifi, Texte).

Exemple :

HeroQRDataTypesDataType; $qrCode = $qrCodeManager # Set the data to be encoded and validation Email ->setData('[email protected]', DataType::Email) # Set the background color ->setBackgroundColor('#000000') # Set the QR code's color ->setColor('#b434eb') # Set the size ->setSize(350) # Set the logo to be embedded at the center # Set the logo size default value is 40 ->setLogo('../assets/HeroExpert.png', 30 ) # Set the margin around ->setMargin(10) # Set the character encoding ->setEncoding('UTF-8') # Set the label ->setLabel( # Label Text label: 'My Email', # Label align textAlign: 'center', # Label text color textColor: '#a503fc', # Label size default value is 20 fontSize: 15, # Label margin default value is (0, 10, 10, 10) margin: [15, 15, 15, 15] ) # Generate the QR code in WebP format ->generate('webp'); # Save the generated QR code to a file $qrCode->saveTo('custom-qrcode'); ">

 use HeroQR  DataTypes  DataType ;

$ qrCode = $ qrCodeManager
    # Set the data to be encoded and validation Email
    -> setData ( ' [email protected] ' , DataType::Email)  
    # Set the background color
    -> setBackgroundColor ( ' #000000 ' )
    # Set the QR code's color
    -> setColor ( ' #b434eb ' )
    # Set the size
    -> setSize ( 350 )
    # Set the logo to be embedded at the center
    # Set the logo size default value is 40
    -> setLogo ( ' ../assets/HeroExpert.png ' , 30 )
    # Set the margin around
    -> setMargin ( 10 )
    # Set the character encoding
    -> setEncoding ( ' UTF-8 ' )
    # Set the label 
    -> setLabel (
        # Label Text
        label: ' My Email ' ,
        # Label align
        textAlign: ' center ' ,
        # Label text color
        textColor: ' #a503fc ' ,
        # Label size default value is 20
        fontSize: 15 ,
        # Label margin default value is (0, 10, 10, 10)
        margin: [ 15 , 15 , 15 , 15 ] 
    )
    # Generate the QR code in WebP format
    -> generate ( ' webp ' );

# Save the generated QR code to a file
$ qrCode -> saveTo ( ' custom-qrcode ' );

Avec ces options, vous pouvez créer des codes QR visuellement attrayants qui correspondent à vos besoins de conception.

3. Options de sortie avancées

HeroQR prend en charge des options de sortie avancées pour une plus grande flexibilité lors de la génération de codes QR :

Sortie matricielle : représente le code QR sous la forme d'une matrice (tableau 2D) de bits, où chaque bloc de la matrice correspond à un élément spécifique des données codées. Vous pouvez récupérer la matrice sous deux formes :
- En tant qu'objet Matrix .
- En tant que tableau 2D, ce qui facilite la manipulation ou l'affichage directement dans certaines applications.
Encodage Base64 : générez le code QR sous forme de chaîne codée en Base64, ce qui est idéal pour l'intégration directe dans du HTML, des e-mails ou d'autres médias.
URI de données : obtenez le code QR sous forme d'URI de données, qui est une représentation sous forme de chaîne compacte de l'image qui peut être intégrée directement dans HTML.
Enregistrement dans différents formats : vous pouvez enregistrer le code QR dans une variété de formats tels que PNG, SVG, GIF, WebP, EPS, PDF, binaire, etc. Le format est automatiquement déterminé en fonction du type de sortie souhaité.

Exemple :

 # Get the QR code as a string representation
$ string = $ qrCode -> getString ();

# Get the QR code as a matrix object
$ matrix = $ qrCode -> getMatrix ();

# Get the matrix as a 2D array
$ matrixArray = $ qrCode -> getMatrixAsArray ();

# Get the QR code as Base64 encoding for embedding in HTML
$ dataUri = $ qrCode -> getDataUri ();

# Save the QR code to a file in the desired format (WebP, GIF, Binary, Esp, PNG, SVG, PDF)
$ qrCode -> saveTo ( ' qr_code_output ' );

Structure du projet

La structure modulaire de HeroQR garantit facilité d'utilisation et évolutivité :

Contrats : définit les interfaces pour les composants principaux, garantissant la cohérence dans l'ensemble du système.
Noyau : Contient la logique principale de génération et de gestion des codes QR.
DataTypes : gère les définitions des différents types de données (emplacement, URL, e-mail, téléphone, texte) et effectue une validation automatique pour chaque type, afin que les utilisateurs n'aient pas besoin de valider les données manuellement.
Gestionnaires : gère la personnalisation et le traitement des codes QR, offrant une flexibilité maximale aux utilisateurs.

Contribuer

Nous apprécions vos contributions! Voici comment vous pouvez vous impliquer :

Forkez le référentiel.
Créez une branche de fonctionnalités : git checkout -b feature-name .
Validez vos modifications avec des messages clairs : git commit -m 'Add feature-name' .
Poussez votre branche : git push origin feature-name .
Ouvrez une pull request pour examen.