bitandblack/qr-code

Generates QR Codes

1.0.0 2024-12-19 15:20 UTC

Requires

• php: >=8.2
• ext-fileinfo: *
• ext-simplexml: *
• bacon/bacon-qr-code: ^3.0
• bitandblack/colors: ^2.4
• symfony/options-resolver: ^6.0 || ^7.0
• symfony/property-access: ^6.0 || ^7.0

Requires (Dev)

• ext-gd: *
• khanamiryan/qrcode-detector-decoder: ^2.0
• phpstan/phpstan: ^1.0
• phpunit/phpunit: ^11.0
• rector/rector: ^1.0
• symfony/var-dumper: ^7.0
• symplify/easy-coding-standard: ^12.0

MIT

• Tobias Köngeter

• code
• qrcode
• png
• qr
• svg
• rgb
• cmyk
• eps

README

Bit&Black QR Code

This library generates QR codes. It's based on endroid/qr-code by Jeroen van den Enden but differs by using bitandblack/colors to allow different color spaces.

Installation

This library is made for the use with Composer. Add it to your project by running $ composer require bitandblack/qr-code.

Usage

<?php 

use BitAndBlack\QrCode\QrCode;

$qrCode = new QrCode('Hello World!');

header('Content-Type: ' . $qrCode->getContentType());

echo $qrCode->writeString();

Advanced usage

<?php 

use Color\Value\RGB;
use BitAndBlack\QrCode\ErrorCorrectionLevel;
use BitAndBlack\QrCode\LabelAlignment;
use BitAndBlack\QrCode\QrCode;
use BitAndBlack\QrCode\Response\QrCodeResponse;

$qrCode = new QrCode('Hello World!');
$qrCode
    ->setSize(300)    
    ->setWriterByName('png')    
    ->setMargin(10)    
    ->setEncoding('UTF-8')    
    ->setErrorCorrectionLevel(
        new ErrorCorrectionLevel(ErrorCorrectionLevel::HIGH())
    )    
    ->setForegroundColor(
        new RGB(0, 0, 0)
    )    
    ->setBackgroundColor(
        new RGB(255, 255, 255)
    )    
    ->setLabel('Scan the code', 16, 'SomeFont.otf', LabelAlignment::CENTER)    
    ->setLogoPath('SomeLogo.png')    
    ->setLogoSize(150, 200)    
    ->setRoundBlockSize(true)    
    ->setValidateResult(false)    
    ->setWriterOptions([
        'exclude_xml_declaration' => true
    ])
;

// Directly output the QR code
header('Content-Type: ' . $qrCode->getContentType());

echo $qrCode->writeString();

// Save it to a file
$qrCode->writeFile(__DIR__ . '/qrcode.png');

// Create a response object
$response = new QrCodeResponse($qrCode);

Help

If you have any questions, feel free to contact us under [e-mail].

Further information about Bit&Black can be found under www.bitandblack.com.