README

This is a qr code generator package that can customize your own QRcode with size, color, background color, margin, icon, curve, and frame.

Run this command to install package

$ composer require wenxin/qrcode

Install Imagick Extension

User is requires to install Imagick PHP extension to create and modify images in this package.

https://pecl.php.net/package/imagick

Open config/app.php file and add this class to the providers array.

Wenxin\Qrcode\QrCodeServiceProvider::class

At the same file (config/app.php) add the following line to aliases array.

'QrCode' => Wenxin\Qrcode\Facades\QrCode::class

Add 'use QrCode' on top when you are implementing.

use QrCode;

Description Parameters and Example

format('png') - string

QR code file type

size(500) - integer

Sets QR code size(px). Size range from 0 to 1000px.

color('8E44AD') - string

Sets QR code color(Hex). Keyin without '#', example: 28B463, 8E44AD

backgroundColor('FDEBD0') - string

Sets QR code background color(Hex). Keyin without '#', example: F9E79F, FDEBD0

margin(2) - integer

Sets border size(px) of the QR code. Size range from 0 to 10px.

errorCorrection('H') - string

Sets QR code error correction. QR Code has error correction capability to restore data if the code is dirty or damaged. Four error correction levels ('L' - 7%, 'M' - 15%, 'Q' - 25%, 'H' - 30%) are available for users to choose according to the operating environment. Raising this level improves error correction capability but also increases the amount of data QR Code size.

encoding('UTF-8') - string

Sets the character encoder.Define 'UTF-8' as a default value.
Encoding list : ISO-8859-1, ISO-8859-2 ,ISO-8859-3, ISO-8859-4, ISO-8859-5, ISO-8859-6, ISO-8859-7, ISO-8859-8, ISO-8859-9, ISO-8859-10, ISO-8859-11, ISO-8859-12, ISO-8859-13, ISO-8859-14, ISO-8859-15, ISO-8859-16, SHIFT-JIS, WINDOWS-1250, WINDOWS-1251, WINDOWS-1252, WINDOWS-1256, UTF-16BE, UTF-8, ASCII, GBK, EUC-KR.

generate('This is a QR code generator.', storage_path('qrcode.png')) - string

QR code content value e.g Text, URl, Tel.
Save 'qrcode.png' file at laravel storage.

curve(5) - integer

Sets curve size (px) of QR code. Size range from 1 to 10px.

merge_icon('icon/logo14.png', 4) - string, integer

Upload and merge icon at the center of the QR code. Maximum 5MB (upload .png file only)
Sets size of the icon. Range of the size is 2 to 5. The larger the number the smaller the size.

frame('frame/frame8.png', 630, 630) - string, integer

Upload frame for merge QR code. Maximum 5MB (upload .png file only).
Sets frame width and height size(px) of QR code frame. Maximum 1100px.

position(100, 100) - integer

Sets position X and Y (px) of QR code in the frame. Position range from 0 to 300px.

Overwrite

True: To allow the system overwrite the existing QRcode and overwrite with the new one.
False: System will not allow duplicate filename, it will prompt an error.

Workflow of the QR code generator

First, generate a basic qrcode and saved file as 'qrcode.png'. Then, use 'qrcode.png' file to implement the customize with curve, icon, and frame.

Important

Have to follow the sequence

Example Code (Have to follow the sequence)

        $qrcodeImage = QrCode::format('png') //set qr format
            ->size(300) // set qrcode size
            ->errorCorrection('H') //set qrcode error correction
            ->color('FF00FF') //set qr color
            ->backgroundColor('00FF00') // set qrcode background color                              
            ->encoding('UTF-8') //set the character encoder.
            ->overwrite(true) //set new qrcode will overwrite existing file
            ->margin(0) // set qrcode border   
            ->generate('This is a custom QR code generator.','qr') //set qrdata ,and second param is filename (optional)
            ->curve(5) // set curve of the qrcode
            ->merge_icon('icon/download.png',4)  // merge icon at the center of the qrcode & set icon size
            ->frame('frame/frame2.png', 600, 600) //frame file ,frame width and height
            ->position(150,150);  //set qrcode position x and y in the frame

wenxin / qrcode

Maintainers

Details