PHPackages endroid/qr-code - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. endroid/qr-code ActiveLibrary[Utility & Helpers](/categories/utility) endroid/qr-code =============== Endroid QR Code 6.1.3(3mo ago)4.8k67.6M—2.5%771[9 issues](https://github.com/endroid/qr-code/issues)[4 PRs](https://github.com/endroid/qr-code/pulls)20MITPHPPHP ^8.4CI passing Since Oct 27Pushed 3mo ago120 watchersCompare [ Source](https://github.com/endroid/qr-code)[ Packagist](https://packagist.org/packages/endroid/qr-code)[ Docs](https://github.com/endroid/qr-code)[ GitHub Sponsors](https://github.com/endroid)[ RSS](/packages/endroid-qr-code/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (4)Versions (203)Used By (20) QR Code ======= [](#qr-code) *By [endroid](https://endroid.nl/)* All my work is coffeerighted ☕ 😉 If you like my work please support me by visiting the [sponsor page](https://github.com/sponsors/endroid) or you can [buy me a coffee](https://www.buymeacoffee.com/endroid) ☕ [![Latest Stable Version](https://camo.githubusercontent.com/10e6b23b667743473662e47eb09fb5137e08d015f5ecf13964d07816057738ec/687474703a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f656e64726f69642f71722d636f64652e737667)](https://packagist.org/packages/endroid/qr-code)[![Build Status](https://github.com/endroid/qr-code/workflows/CI/badge.svg)](https://github.com/endroid/qr-code/actions)[![Total Downloads](https://camo.githubusercontent.com/5387d9dc0b9b66f5c2979706fe5ca33ac50e9625fb41ac46bc0d22bcfa7920c8/687474703a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f656e64726f69642f71722d636f64652e737667)](https://packagist.org/packages/endroid/qr-code)[![Monthly Downloads](https://camo.githubusercontent.com/029d2d3560d7848ca4368b3b98283dc21d69e05ddfd935dd2490bb0517c777fb/687474703a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646d2f656e64726f69642f71722d636f64652e737667)](https://packagist.org/packages/endroid/qr-code)[![License](https://camo.githubusercontent.com/63e8babee0b0722d422d24d28f3a961496da2ec9d0dd7ee29a57282f9dcee283/687474703a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f656e64726f69642f71722d636f64652e737667)](https://packagist.org/packages/endroid/qr-code) This library helps you generate QR codes in a jiffy. Makes use of [bacon/bacon-qr-code](https://github.com/Bacon/BaconQrCode)to generate the matrix and [khanamiryan/qrcode-detector-decoder](https://github.com/khanamiryan/php-qrcode-detector-decoder)for validating generated QR codes. Further extended with Twig extensions, generation routes, a factory and a Symfony bundle for easy installation and configuration. Different writers are provided to generate the QR code as PNG, WebP, SVG, EPS or in binary format. Sponsored by ------------ [](#sponsored-by) [![Blackfire.io](.github/blackfire.png)](https://www.blackfire.io) Installation ------------ [](#installation) Use [Composer](https://getcomposer.org/) to install the library. Also make sure you have enabled and configured the [GD extension](https://www.php.net/manual/en/book.image.php) if you want to generate images. ``` composer require endroid/qr-code ``` Usage: using the builder ------------------------ [](#usage-using-the-builder) ``` use Endroid\QrCode\Builder\Builder; use Endroid\QrCode\Encoding\Encoding; use Endroid\QrCode\ErrorCorrectionLevel; use Endroid\QrCode\Label\LabelAlignment; use Endroid\QrCode\Label\Font\OpenSans; use Endroid\QrCode\RoundBlockSizeMode; use Endroid\QrCode\Writer\PngWriter; $builder = new Builder( writer: new PngWriter(), writerOptions: [], validateResult: false, data: 'Custom QR code contents', encoding: new Encoding('UTF-8'), errorCorrectionLevel: ErrorCorrectionLevel::High, size: 300, margin: 10, roundBlockSizeMode: RoundBlockSizeMode::Margin, logoPath: __DIR__.'/assets/bender.png', logoResizeToWidth: 50, logoPunchoutBackground: true, labelText: 'This is the label', labelFont: new OpenSans(20), labelAlignment: LabelAlignment::Center ); $result = $builder->build(); ``` Usage: without using the builder -------------------------------- [](#usage-without-using-the-builder) ``` use Endroid\QrCode\Color\Color; use Endroid\QrCode\Encoding\Encoding; use Endroid\QrCode\ErrorCorrectionLevel; use Endroid\QrCode\QrCode; use Endroid\QrCode\Label\Label; use Endroid\QrCode\Logo\Logo; use Endroid\QrCode\RoundBlockSizeMode; use Endroid\QrCode\Writer\PngWriter; use Endroid\QrCode\Writer\ValidationException; $writer = new PngWriter(); // Create QR code $qrCode = new QrCode( data: 'Life is too short to be generating QR codes', encoding: new Encoding('UTF-8'), errorCorrectionLevel: ErrorCorrectionLevel::Low, size: 300, margin: 10, roundBlockSizeMode: RoundBlockSizeMode::Margin, foregroundColor: new Color(0, 0, 0), backgroundColor: new Color(255, 255, 255) ); // Create generic logo $logo = new Logo( path: __DIR__.'/assets/bender.png', resizeToWidth: 50, punchoutBackground: true ); // Create generic label $label = new Label( text: 'Label', textColor: new Color(255, 0, 0) ); $result = $writer->write($qrCode, $logo, $label); // Validate the result $writer->validateResult($result, 'Life is too short to be generating QR codes'); ``` Usage: working with results --------------------------- [](#usage-working-with-results) ``` // Directly output the QR code header('Content-Type: '.$result->getMimeType()); echo $result->getString(); // Save it to a file $result->saveToFile(__DIR__.'/qrcode.png'); // Generate a data URI to include image data inline (i.e. inside an tag) $dataUri = $result->getDataUri(); ``` [![QR Code](.github/example.png)](.github/example.png) ### Writer options [](#writer-options) Some writers provide writer options. Each available writer option is can be found as a constant prefixed with WRITER\_OPTION\_ in the writer class. - `PdfWriter` - `unit`: unit of measurement (default: mm) - `fpdf`: PDF to place the image in (default: new PDF) - `x`: image offset (default: 0) - `y`: image offset (default: 0) - `link`: a URL or an identifier returned by `AddLink()`. - `PngWriter` - `compression_level`: compression level (0-9, default: -1 = zlib default) - `number_of_colors`: number of colors (1-256, null for true color and transparency) - `SvgWriter` - `block_id`: id of the block element for external reference (default: block) - `exclude_xml_declaration`: exclude XML declaration (default: false) - `exclude_svg_width_and_height`: exclude width and height (default: false) - `force_xlink_href`: forces xlink namespace in case of compatibility issues (default: false) - `compact`: create using `path` element, otherwise use `defs` and `use` (default: true) - `WebPWriter` - `quality`: image quality (0-100, default: 80) You can provide any writer options like this. ``` use Endroid\QrCode\Writer\SvgWriter; $builder = new Builder( writer: new SvgWriter(), writerOptions: [ SvgWriter::WRITER_OPTION_EXCLUDE_XML_DECLARATION => true ] ); ``` ### Encoding [](#encoding) If you use a barcode scanner you can have some troubles while reading the generated QR codes. Depending on the encoding you chose you will have an extra amount of data corresponding to the ECI block. Some barcode scanner are not programmed to interpret this block of information. To ensure a maximum compatibility you can use the `ISO-8859-1` encoding that is the default encoding used by barcode scanners (if your character set supports it, i.e. no Chinese characters are present). ### Round block size mode [](#round-block-size-mode) By default block sizes are rounded to guarantee sharp images and improve readability. However some other rounding variants are available. - `margin (default)`: the size of the QR code is shrunk if necessary but the size of the final image remains unchanged due to additional margin being added. - `enlarge`: the size of the QR code and the final image are enlarged when rounding differences occur. - `shrink`: the size of the QR code and the final image are shrunk when rounding differences occur. - `none`: No rounding. This mode can be used when blocks don't need to be rounded to pixels (for instance SVG). Readability ----------- [](#readability) The readability of a QR code is primarily determined by the size, the input length, the error correction level and any possible logo over the image so you can tweak these parameters if you are looking for optimal results. You can also check $qrCode->getRoundBlockSize() value to see if block dimensions are rounded so that the image is more sharp and readable. Please note that rounding block size can result in additional padding to compensate for the rounding difference. And finally the encoding (default UTF-8 to support large character sets) can be set to `ISO-8859-1` if possible to improve readability. Validating the generated QR code -------------------------------- [](#validating-the-generated-qr-code) If you need to be extra sure the QR code you generated is readable and contains the exact data you requested you can enable the validation reader, which is disabled by default. You can do this either via the builder or directly on any writer that supports validation. See the examples above. Please note that validation affects performance so only use it in case of problems. Symfony integration ------------------- [](#symfony-integration) The [endroid/qr-code-bundle](https://github.com/endroid/qr-code-bundle)integrates the QR code library in Symfony for an even better experience. - Configure your defaults (like image size, default writer etc.) - Support for multiple configurations and injection via aliases - Generate QR codes for defined configurations via URL like /qr-code//Hello - Generate QR codes or URLs directly from Twig using dedicated functions Read the [bundle documentation](https://github.com/endroid/qr-code-bundle)for more information. Versioning ---------- [](#versioning) Version numbers follow the MAJOR.MINOR.PATCH scheme. Backwards compatibility breaking changes will be kept to a minimum but be aware that these can occur. Lock your dependencies for production and test your code when upgrading. License ------- [](#license) This bundle is under the MIT license. For the full copyright and license information please view the LICENSE file that was distributed with this source code. ### Health Score 84 — ExcellentBetter than 100% of packages Maintenance81 Actively maintained with recent releases Popularity83 Widely adopted with strong download metrics Community59 Growing community involvement Maturity100 Battle-tested with a long release history Bus Factor1 Top contributor holds 87.1% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~24 days Recently: every ~51 days Total 200 Last Release 102d ago Major Versions 2.x-dev → 3.9.42020-11-27 3.9.6 → 4.0.02021-02-28 3.x-dev → 4.1.32021-04-26 4.8.5 → 5.0.02023-10-02 5.1.0 → 6.0.02024-10-21 PHP version history (11 changes)1.0.0PHP >=5.3.0 1.8.0PHP >=5.4 2.0.0PHP >=5.6 3.0.0PHP >=7.1 3.6.0PHP >=7.2 4.0.0PHP ^7.3||^8.0 4.4.0PHP ^7.4||^8.0 4.7.0PHP ^8.0 4.8.3PHP ^8.1 6.0.0PHP ^8.2 6.1.0PHP ^8.4 ### Community Maintainers ![](https://www.gravatar.com/avatar/ea3fc1b297f29579f9861b5fbe3240c0eeafaaaee6e39b45d85d612a04a52fbd?d=identicon)[endroid](/maintainers/endroid) --- Top Contributors [![endroid](https://avatars.githubusercontent.com/u/537253?v=4)](https://github.com/endroid "endroid (419 commits)")[![sprain](https://avatars.githubusercontent.com/u/260361?v=4)](https://github.com/sprain "sprain (11 commits)")[![MaximilianKresse](https://avatars.githubusercontent.com/u/545671?v=4)](https://github.com/MaximilianKresse "MaximilianKresse (7 commits)")[![ThomasLandauer](https://avatars.githubusercontent.com/u/1054469?v=4)](https://github.com/ThomasLandauer "ThomasLandauer (5 commits)")[![Trismegiste](https://avatars.githubusercontent.com/u/1260026?v=4)](https://github.com/Trismegiste "Trismegiste (5 commits)")[![laurentmuller](https://avatars.githubusercontent.com/u/4330059?v=4)](https://github.com/laurentmuller "laurentmuller (3 commits)")[![juuuuuu](https://avatars.githubusercontent.com/u/1769769?v=4)](https://github.com/juuuuuu "juuuuuu (3 commits)")[![Runrioter](https://avatars.githubusercontent.com/u/1078011?v=4)](https://github.com/Runrioter "Runrioter (2 commits)")[![thijskh](https://avatars.githubusercontent.com/u/3808792?v=4)](https://github.com/thijskh "thijskh (2 commits)")[![JohannCOSTE](https://avatars.githubusercontent.com/u/19409426?v=4)](https://github.com/JohannCOSTE "JohannCOSTE (2 commits)")[![edorfaus](https://avatars.githubusercontent.com/u/112590?v=4)](https://github.com/edorfaus "edorfaus (2 commits)")[![ice6](https://avatars.githubusercontent.com/u/889040?v=4)](https://github.com/ice6 "ice6 (2 commits)")[![louislam](https://avatars.githubusercontent.com/u/1336778?v=4)](https://github.com/louislam "louislam (1 commits)")[![marcosgdf](https://avatars.githubusercontent.com/u/168744?v=4)](https://github.com/marcosgdf "marcosgdf (1 commits)")[![Slamdunk](https://avatars.githubusercontent.com/u/152236?v=4)](https://github.com/Slamdunk "Slamdunk (1 commits)")[![Spomky](https://avatars.githubusercontent.com/u/1091072?v=4)](https://github.com/Spomky "Spomky (1 commits)")[![theianjohnson](https://avatars.githubusercontent.com/u/4634364?v=4)](https://github.com/theianjohnson "theianjohnson (1 commits)")[![AlexKovalevych](https://avatars.githubusercontent.com/u/577231?v=4)](https://github.com/AlexKovalevych "AlexKovalevych (1 commits)")[![Woodehh](https://avatars.githubusercontent.com/u/6039482?v=4)](https://github.com/Woodehh "Woodehh (1 commits)")[![Amunak](https://avatars.githubusercontent.com/u/781546?v=4)](https://github.com/Amunak "Amunak (1 commits)") --- Tags data-urifactoryphpqrcodereadertwig-extensionphpqrcodeqrcodeendroid ### Embed Badge ![Health badge](/badges/endroid-qr-code/health.svg) ``` [![Health](https://phpackages.com/badges/endroid-qr-code/health.svg)](https://phpackages.com/packages/endroid-qr-code) ``` ### Alternatives [amirezaeb/heroqr A Powerful QR Code Management Library For PHP 9510.3k](/packages/amirezaeb-heroqr)[arcanedev/qr-code QR Code generator 1231.9k1](/packages/arcanedev-qr-code)[linkxtr/laravel-qrcode A clean, modern, and easy-to-use QR code generator for Laravel 295.1k](/packages/linkxtr-laravel-qrcode) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)