mirror of
https://github.com/chillerlan/php-qrcode.git
synced 2026-08-19 05:30:05 +00:00
smiley
91 lines
4.9 KiB
Markdown
91 lines
4.9 KiB
Markdown
# Overview
|
|
|
|
A PHP QR Code generator based on the [implementation by Kazuhiko Arase](https://github.com/kazuhikoarase/qrcode-generator), namespaced, cleaned up, improved and other stuff.
|
|
It also features a QR Code reader based on a [PHP port](https://github.com/khanamiryan/php-qrcode-detector-decoder) of the [ZXing library](https://github.com/zxing/zxing).
|
|
|
|
|
|
## Features
|
|
|
|
- Creation of [Model 2 QR Codes](https://www.qrcode.com/en/codes/model12.html), [Version 1 to 40](https://www.qrcode.com/en/about/version.html)
|
|
- [ECC Levels](https://www.qrcode.com/en/about/error_correction.html) L/M/Q/H supported
|
|
- Mixed mode support (encoding modes can be combined within a QR symbol). Supported modes:
|
|
- numeric
|
|
- alphanumeric
|
|
- 8-bit binary
|
|
- [ECI support](https://en.wikipedia.org/wiki/Extended_Channel_Interpretation)
|
|
- 13-bit double-byte:
|
|
- kanji (Japanese, Shift-JIS)
|
|
- hanzi (simplified Chinese, GB2312/GB18030) as [defined in GBT18284-2000](https://www.chinesestandard.net/PDF/English.aspx/GBT18284-2000)
|
|
- Flexible, easily extensible output modules, built-in support for the following output formats:
|
|
- [GdImage](https://www.php.net/manual/book.image) (raster graphics: avif, bmp, gif, jpeg, png, webp)
|
|
- [ImageMagick](https://www.php.net/manual/book.imagick) ([multiple supported image formats](https://imagemagick.org/script/formats.php))
|
|
- Markup types: SVG, HTML, etc.
|
|
- String types: JSON, plain text, etc.
|
|
- Encapsulated Postscript (EPS)
|
|
- PDF via [FPDF](https://github.com/setasign/fpdf)
|
|
- QR Code reader (via GD and ImageMagick)
|
|
|
|
|
|
## Requirements
|
|
|
|
- PHP 8.2+
|
|
- [`ext-mbstring`](https://www.php.net/manual/book.mbstring.php)
|
|
- optional:
|
|
- [`ext-gd`](https://www.php.net/manual/book.image)
|
|
- [`ext-imagick`](https://github.com/Imagick/imagick) with [ImageMagick](https://imagemagick.org) installed
|
|
- [`ext-fileinfo`](https://www.php.net/manual/book.fileinfo.php) (required by `QRImagick` output)
|
|
- [`setasign/fpdf`](https://github.com/setasign/fpdf) for the PDF output module
|
|
- [`intervention/image`](https://github.com/Intervention/image) for alternative GD/ImageMagick output
|
|
|
|
For the QR Code reader, either `ext-gd` or `ext-imagick` is required!
|
|
|
|
|
|
## Framework Integration
|
|
|
|
- CakePHP:
|
|
- [QrCode plugin](https://github.com/dereuromark/cakephp-qrcode)
|
|
- Drupal:
|
|
- [Two-factor Authentication `tfa`](https://www.drupal.org/project/tfa) (Drupal 8+)
|
|
- [Google Authenticator Login `ga_login`](https://www.drupal.org/project/ga_login) (deprecated, Drupal 7)
|
|
- Laravel:
|
|
- [Filament](https://github.com/filamentphp/filament)
|
|
- Symfony:
|
|
- [phpqrcode-bundle](https://github.com/jonasarts/phpqrcode-bundle)
|
|
- WoltLab Suite:
|
|
- [two-step-verification](http://pluginstore.woltlab.com/file/3007-two-step-verification/)
|
|
- [[Developer] PHP QR Code](https://www.woltlab.com/pluginstore/file/7995-entwickler-php-qr-code/)
|
|
- WordPress:
|
|
- [wp-two-factor-auth](https://github.com/sjinks/wp-two-factor-auth)
|
|
- [simple-2fa](https://wordpress.org/plugins/simple-2fa/)
|
|
- [floating-share-button](https://github.com/qriouslad/floating-share-button)
|
|
- other uses:
|
|
- [dependents](https://github.com/chillerlan/php-qrcode/network/dependents) / [packages](https://github.com/chillerlan/php-qrcode/network/dependents?dependent_type=PACKAGE)
|
|
- [Appwrite](https://github.com/appwrite/appwrite)
|
|
- [Cachet](https://github.com/CachetHQ/Cachet)
|
|
- [GÉANT CAT](https://github.com/GEANT/CAT)
|
|
- [Elefant CMS](https://github.com/jbroadway/elefant)
|
|
- [EspoCRM](https://github.com/espocrm/espocrm)
|
|
- [FusionCMS](https://github.com/FusionWowCMS/FusionCMS)
|
|
- [HortusFox](https://github.com/danielbrendel/hortusfox-web)
|
|
- [Laravel Boleto](https://github.com/eduardokum/laravel-boleto)
|
|
- [LORIS](https://github.com/aces/Loris)
|
|
- [OpenBoleto](https://github.com/openboleto/openboleto)
|
|
- [openITCOCKPIT](https://github.com/it-novum/openITCOCKPIT)
|
|
- [OSIRIS](https://github.com/JKoblitz/osiris)
|
|
- [Pelican Panel](https://github.com/pelican-dev/panel)
|
|
- [twill](https://github.com/area17/twill)
|
|
- Articles:
|
|
- [Twilio: How to Create a QR Code in PHP](https://www.twilio.com/blog/create-qr-code-in-php) (featuring v4.3.x)
|
|
|
|
|
|
## Shameless advertising
|
|
|
|
Hi, please check out some of my other projects that are way cooler than qrcodes!
|
|
|
|
- [js-qrcode](https://github.com/chillerlan/js-qrcode) - a javascript port of this library
|
|
- [php-authenticator](https://github.com/chillerlan/php-authenticator) - a Google Authenticator implementation (see [authenticator example](https://github.com/chillerlan/php-qrcode/blob/main/examples/authenticator.php))
|
|
- [php-httpinterface](https://github.com/chillerlan/php-httpinterface) - a PSR-7/15/17/18 implemetation
|
|
- [php-oauth](https://github.com/chillerlan/php-oauth) - an OAuth 1/2 client library, fully PSR-7/PSR-17/PSR-18 compatible
|
|
- [php-database](https://github.com/chillerlan/php-database) - a database client & querybuilder for MySQL, Postgres, SQLite, MSSQL, Firebird
|
|
- [php-tootbot](https://github.com/php-tootbot/tootbot-template) - a Mastodon bot library
|