Overview.md.txt 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. # Overview
  2. 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.
  3. 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).
  4. ## Features
  5. - 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)
  6. - [ECC Levels](https://www.qrcode.com/en/about/error_correction.html) L/M/Q/H supported
  7. - Mixed mode support (encoding modes can be combined within a QR symbol). Supported modes:
  8. - numeric
  9. - alphanumeric
  10. - 8-bit binary
  11. - [ECI support](https://en.wikipedia.org/wiki/Extended_Channel_Interpretation)
  12. - 13-bit double-byte:
  13. - kanji (Japanese, Shift-JIS)
  14. - hanzi (simplified Chinese, GB2312/GB18030) as [defined in GBT18284-2000](https://www.chinesestandard.net/PDF/English.aspx/GBT18284-2000)
  15. - Flexible, easily extensible output modules, built-in support for the following output formats:
  16. - [GdImage](https://www.php.net/manual/book.image) (raster graphics: avif, bmp, gif, jpeg, png, webp)
  17. - [ImageMagick](https://www.php.net/manual/book.imagick) ([multiple supported image formats](https://imagemagick.org/script/formats.php))
  18. - Markup types: SVG, HTML, etc.
  19. - String types: JSON, plain text, etc.
  20. - Encapsulated Postscript (EPS)
  21. - PDF via [FPDF](https://github.com/setasign/fpdf)
  22. - QR Code reader (via GD and ImageMagick)
  23. ## Requirements
  24. - PHP 7.4+
  25. - [`ext-mbstring`](https://www.php.net/manual/book.mbstring.php)
  26. - optional:
  27. - [`ext-fileinfo`](https://www.php.net/manual/book.fileinfo.php) (required by `QRImagick` output)
  28. - [`ext-gd`](https://www.php.net/manual/book.image)
  29. - [`ext-imagick`](https://github.com/Imagick/imagick) with [ImageMagick](https://imagemagick.org) installed
  30. - [`setasign/fpdf`](https://github.com/setasign/fpdf) for the PDF output module
  31. For the QR Code reader, either `ext-gd` or `ext-imagick` is required!
  32. ## Framework Integration
  33. - Drupal:
  34. - [Two-factor Authentication `tfa`](https://www.drupal.org/project/tfa) (Drupal 8+)
  35. - [Google Authenticator Login `ga_login`](https://www.drupal.org/project/ga_login) (deprecated, Drupal 7)
  36. - Symfony
  37. - [phpqrcode-bundle](https://github.com/jonasarts/phpqrcode-bundle)
  38. - WordPress:
  39. - [wp-two-factor-auth](https://github.com/sjinks/wp-two-factor-auth)
  40. - [simple-2fa](https://wordpress.org/plugins/simple-2fa/)
  41. - [floating-share-button](https://github.com/qriouslad/floating-share-button)
  42. - WoltLab Suite
  43. - [two-step-verification](http://pluginstore.woltlab.com/file/3007-two-step-verification/)
  44. - other uses:
  45. - [dependents](https://github.com/chillerlan/php-qrcode/network/dependents) / [packages](https://github.com/chillerlan/php-qrcode/network/dependents?dependent_type=PACKAGE)
  46. - [Appwrite](https://github.com/appwrite/appwrite)
  47. - [Cachet](https://github.com/CachetHQ/Cachet)
  48. - [GÉANT CAT](https://github.com/GEANT/CAT)
  49. - [openITCOCKPIT](https://github.com/it-novum/openITCOCKPIT)
  50. - [twill](https://github.com/area17/twill)
  51. - [Elefant CMS](https://github.com/jbroadway/elefant)
  52. - [OSIRIS](https://github.com/JKoblitz/osiris)
  53. - [EspoCRM](https://github.com/espocrm/espocrm)
  54. - Articles:
  55. - [Twilio: How to Create a QR Code in PHP](https://www.twilio.com/blog/create-qr-code-in-php) (featuring v4.3.x)
  56. ## Shameless advertising
  57. Hi, please check out some of my other projects that are way cooler than qrcodes!
  58. - [js-qrcode](https://github.com/chillerlan/js-qrcode) - a javascript port of this library
  59. - [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))
  60. - [php-httpinterface](https://github.com/chillerlan/php-httpinterface) - a PSR-7/15/17/18 implemetation
  61. - [php-oauth-core](https://github.com/chillerlan/php-oauth-core) - an OAuth 1/2 client library along with a bunch of [providers](https://github.com/chillerlan/php-oauth-providers)
  62. - [php-database](https://github.com/chillerlan/php-database) - a database client & querybuilder for MySQL, Postgres, SQLite, MSSQL, Firebird
  63. - [php-tootbot](https://github.com/php-tootbot/tootbot-template) - a Mastodon bot library