lautr / qrcode-bundle
Endroid Qr Code Bundle for Symfony
Requires
- php: >=5.3.0
- endroid/qrcode: ~1.3
Requires (Dev)
- sensio/framework-extra-bundle: ~3.0
- symfony/browser-kit: ~2.1
- symfony/class-loader: ~2.1
- symfony/expression-language: ~2.1
- symfony/finder: ~2.1
- symfony/form: ~2.1
- symfony/framework-bundle: ~2.1
- symfony/http-kernel: ~2.1
- symfony/yaml: ~2.1
README
By endroid
This bundle provides a default controller for generating QR codes using the Endroid QR Code (endroid/QrCode) library.
Fork
This forks implements some barcode functionality
Requirements
- Symfony
- Dependencies:
QrCode
zend-validator
zend-barcode
Installation
Use Composer to install the bundle.
$ composer require endroid/qrcode-bundle
Then enable the bundle via the kernel.
<?php // app/AppKernel.php public function registerBundles() { $bundles = array( // ... new Endroid\Bundle\QrCodeBundle\EndroidQrCodeBundle(), ); }
Routing
Add the following section to your routing to be able to handle QR code URLs. This step can be skipped when you only use data URIs to display your images.
EndroidQrCodeBundle: resource: "@EndroidQrCodeBundle/Controller/" type: annotation prefix: /qrcode
Configuration
The default QR code generation parameters can be overridden via the configuration. All parameters are optional.
config.yml
endroid_qr_code: size: 100 padding: 10 extension: gif error_correction_level: high foreground_color: { r: 0, g: 0, b: 0, a: 0 } background_color: { r: 255, g: 255, b: 255, a: 0 } label: "My label" labelFontSize: 16
Alpha channel available range is [0, 127] in foreground and background colors.
Twig extension
QR Codes
The bundle also provides a Twig extension for quickly generating QR code urls. Optional parameters are extension, size, padding and errorCorrectionLevel. When a parameter is omitted, the value in the bundle configuration is used.
<img src="{{ qrcode_url(message) }}" /> <img src="{{ qrcode_url(message, extension='png') }}" /> <img src="{{ qrcode_url(message, size=150) }}" />
You can also use the data URI helper to embed the QR code within your HTML instead of requiring a separate HTTP request to load your image.
<img src="{{ qrcode_data_uri(message, size=200, padding=10) }}" />
Bar Codes
<img src="{{ barcode_url(message) }}" /> <img src="{{ barcode_url(message, extension='png') }}" /> <img src="{{ barcode_url(message, size=150) }}" /> <img src="{{ barcode_url(message, type='Code128') }}" />
Usage
After installation and configuration, QR codes can be generated by appending the QR code text to the url as mounted, followed by .png, .jpg or .gif.
Versioning
Semantic versioning (semver) is applied.
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.