php-qrcode

chillerlan/php-qrcode

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.3
• 7.2+ use ^3.4.1 (v3.4.1 also supports PHP8)
• 7.0+ use ^2.0
• 5.6+ use ^1.0 (please let PHP 5 die!)

In case you want to keep using dev-main, specify the hash of a commit to avoid running into unforseen issues like so: dev-main#b625396e0752d79747a55205ae7e191eeb459dcd

PSA: PHP 7.0 - 7.3 are EOL and therefore the respective QRCode versions are also no longer supported!

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
• Symfony
  • phpqrcode-bundle
• WordPress:
  • wp-two-factor-auth
  • simple-2fa
  • wordpress-seo
  • floating-share-button
• WoltLab Suite
  • two-step-verification
• Appwrite
• Cachet
• twill
• 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!

License notice

Parts of this code are ported to php from the ZXing project and licensed under the Apache License, Version 2.0.

Trademark Notice

The word "QR Code" is a registered trademark of DENSO WAVE INCORPORATED
https://www.qrcode.com/en/faq.html#patentH2Title