README

A PHP 7.4+ QR Code library based on the implementation by Kazuhiko Arase, namespaced, cleaned up, improved and other stuff.

Documentation

See the wiki for advanced documentation. An API documentation created with phpDocumentor can be found at https://chillerlan.github.io/php-qrcode/ (WIP).

Requirements

PHP 7.4+
- ext-mbstring
- optional:
  - ext-json, ext-gd
  - ext-imagick with ImageMagick installed
  - setasign/fpdf for the PDF output module

Installation

requires composer

via terminal: composer require chillerlan/php-qrcode

composer.json

{
	"require": {
		"php": "^7.4",
		"chillerlan/php-qrcode": "dev-main"
	}
}

Note: replace dev-main with a version constraint, e.g. ^3.2 - see releases for valid versions. For PHP version ...

7.4+ use ^4.2
7.2+ use ^3.3
7.0+ use ^2.0 (PHP 7.0 and 7.1 are EOL!)
5.6+ use ^1.0 (please let PHP 5 die!)

Quickstart

We want to encode this URI for a mobile authenticator into a QRcode image:

$data = 'otpauth://totp/test?secret=B3JX4VCVJDVNXNZ5&issuer=chillerlan.net';

// quick and simple:
echo '<img src="'.(new QRCode)->render($data).'" alt="QR Code" />';

Wait, what was that? Please again, slower! See Advanced usage on the wiki.

Framework Integration

Drupal Google Authenticator Login ga_login
WordPress wp-two-factor-auth
WordPress Simple 2FA simple-2fa
WoltLab Suite two-step-verification
Cachet
Appwrite
other uses: dependents / packages

Shameless advertising

Hi, please check out my other projects that are way cooler than qrcodes!

php-oauth-core - an OAuth 1/2 client library along with a bunch of providers
php-httpinterface - a PSR-7/15/17/18 implemetation
php-database - a database client & querybuilder for MySQL, Postgres, SQLite, MSSQL, Firebird

Disclaimer!

I don't take responsibility for molten CPUs, misled applications, failed log-ins etc.. Use at your own risk!

Trademark Notice

The word "QR Code" is registered trademark of DENSO WAVE INCORPORATED
http://www.denso-wave.com/qrcode/faqpatent-e.html

liveecommerce / php-qrcode

Maintainers

Details