cmobi/qrcode-bundle

BushidoIOQRCodeBundle

BushidoIOQRCodeBundle

The BushidoIOQRCodeBundle adds QRCode generation support in Symfony2., _(*1)

Features included:, _(*2)

• URL and BASE64 encoded image generation
• Twig filter and function support
• Cacheable images for less CPU usage
• Configurable cache expiration age for both http and https
• Cache and logs path can be located inside or outside Symfony2 app folder tree
• Absolute or relative URL generation
• PNG maximum image size definition (default 1024 pixels)
• Configurable find mask setup (best mask, random mask and default mask value)

Installation

Step 1: Composer

Add the following require line to the composer.json file: ``` json { "require": { "bushidoio/qrcode-bundle": "dev-master" } }, _(*3)

And actually install it in your project using Composer:
``` bash
php composer.phar install

You can also do this in one step with this command: ``` bash $ php composer.phar require bushidoio/qrcode-bundle "dev-master", _(*4)

### Step 2: Enable the bundle

Enable the bundle in the kernel:

``` php
<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new BushidoIO\QRCodeBundle\BushidoIOQRCodeBundle(),
    );
}

Step 3: Enable the route

Add this to your routing configuration in app/config/routing.yml:, _(*5)

``` yaml bushidoio_qrcode: resource: "@BushidoIOQRCodeBundle/Controller/" type: annotation, <sub>(*6)</sub>

Configuration
-------------
You can configure some options in `app/config/config.yml`. Those are the default
values:

``` yaml
bushidoio_qrcode:
    cacheable: true
    cache_dir: ~
    logs_dir: ~
    find_best_mask: true
    find_from_random: false
    default_mask: 2
    png_maximum_size: 1024
    absolute_url: true
    http_max_age: 600
    https_max_age: 600

Usage examples

You can use Twig functions or filtes to create URL or BASE64 encoded images. If no parameters are used the default options for the image are size 3 (87x87 pixels) and PNG format., <sub>(*7)</sub>

``` html , <sub>(*8)</sub>

, <sub>(*9)</sub>

, <sub>(*10)</sub>

, <sub>(*11)</sub>

, <sub>(*12)</sub>

, <sub>(*13)</sub>

, <sub>(*14)</sub>

, <sub>(*15)</sub>

, <sub>(*16)</sub>

, <sub>(*17)</sub>

, <sub>(*18)</sub>

```, <sub>(*19)</sub>

License

This bundle is under the MIT license. See the complete license in the bundle:, <sub>(*20)</sub>

Resources/meta/LICENSE

This bundle uses PHP QR Code encoder under the hood. PHP QR Code is distributed under LGPL 3. Copyright (C) 2010 Dominik Dzienia See complete license in:, <sub>(*21)</sub>

Lib/phpqrcode/LICENSE

PHP QR Code encoder is a PHP implementation of QR Code 2-D barcode generator. It is pure-php LGPL-licensed implementation based on C libqrencode by Kentaro Fukuchi., <sub>(*22)</sub>