codeages/qrcode

Endroid QR Code

Wednesday, August 2, 2017
by Wellming
Repository
3 Watchers
0 Stars
7 Installations

PHP
0 Dependents
0 Suggesters
320 Forks
0 Open issues
61 Versions
0 % Grown

The README.md

QR Code

By endroid, _(*1)

, _(*2)

This library helps you generate QR codes in an easy way and provides a Symfony bundle for rapid integration in your project., _(*3)

Installation

Use Composer to install the library., _(*4)

``` bash $ composer require endroid/qrcode, _(*5)


## Usage

```php
use Endroid\QrCode\ErrorCorrectionLevel;
use Endroid\QrCode\LabelAlignment;
use Endroid\QrCode\QrCode;
use Symfony\Component\HttpFoundation\Response;

// Create a basic QR code
$qrCode = new QrCode('Life is too short to be generating QR codes');
$qrCode->setSize(300);

// Set advanced options
$qrCode
    ->setWriterByName('png')
    ->setMargin(10)
    ->setEncoding('UTF-8')
    ->setErrorCorrectionLevel(ErrorCorrectionLevel::HIGH)
    ->setForegroundColor(['r' => 0, 'g' => 0, 'b' => 0])
    ->setBackgroundColor(['r' => 255, 'g' => 255, 'b' => 255])
    ->setLabel('Scan the code', 16, __DIR__.'/../assets/noto_sans.otf', LabelAlignment::CENTER)
    ->setLogoPath(__DIR__.'/../assets/symfony.png')
    ->setLogoWidth(150)
    ->setValidateResult(false)
;

// Directly output the QR code
header('Content-Type: '.$qrCode->getContentType());
echo $qrCode->writeString();

// Save it to a file
$qrCode->writeFile(__DIR__.'/qrcode.png');

// Create a response object
$response = new Response($qrCode->writeString(), Response::HTTP_OK, ['Content-Type' => $qrCode->getContentType()]);

QR Code , _(*6)

Symfony integration

// app/AppKernel.php

public function registerBundles()
{
    $bundles = [
        // ...
        new Endroid\QrCode\Bundle\EndroidQrCodeBundle(),
    ];
}

The bundle makes use of a factory to create QR codes. The default parameters applied by the factory can optionally be overridden via the configuration., _(*8)

endroid_qr_code:
    writer: 'png'
    size: 300
    margin: 10
    foreground_color: { r: 0, g: 0, b: 0 }
    background_color: { r: 255, g: 255, b: 255 }
    error_correction_level: low # low, medium, quartile or high
    encoding: UTF-8
    label: Scan the code
    label_font_size: 20
    label_alignment: left # left, center or right
    label_margin: { b: 20 }
    logo_path: '%kernel.root_dir%/../vendor/endroid/qrcode/assets/symfony.png'
    logo_width: 150
    validate_result: false # checks if the result is readable

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. The validate_result option uses a built-in reader to validate the resulting image. This does not guarantee that the code will be readable by all readers but this helps you provide a minimum level of quality. Take note that the validator can consume quite an amount of resources and is disabled by default., _(*9)

Now you can retrieve the factory from the service container and create a QR code. For instance in your controller this would look like this., _(*10)

$qrCode = $this->get('endroid.qrcode.factory')->create('QR Code', ['size' => 200]);

Add the following section to your routing to be able to handle QR code URLs. This step can be skipped if you only use data URIs to display your images., _(*11)

``` yml EndroidQrCodeBundle: resource: "@EndroidQrCodeBundle/Controller/" type: annotation prefix: /qrcode, _(*12)


After installation and configuration, QR codes can be generated by appending
the QR code text to the url followed by any of the supported extensions.

## Twig extension

The bundle provides a Twig extension for generating a QR code URL, path or data
URI. You can use the second argument of any of these functions to override any
defaults defined by the bundle or set via your configuration.

``` twig
<img src="{{ qrcode_path(message) }}" />
<img src="{{ qrcode_url(message, { writer: 'eps' }) }}" />
<img src="{{ qrcode_data_uri(message, { writer: 'svg', size: 150 }) }}" />

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., _(*13)

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., _(*14)

The Versions

02/08 2017

dev-master

9999999-dev https://github.com/endroid/QrCode

Endroid QR Code

library qrcode

Endroid QR Code

codeages/qrcode

The README.md

QR Code

Installation

Symfony integration

Versioning

License

The Versions

dev-master

The Requires

The Development Requires

by Jeroen van den Enden

2.2.4

The Requires

The Development Requires

by Jeroen van den Enden

2.2.3

The Requires

The Development Requires

by Jeroen van den Enden

2.2.2

The Requires

The Development Requires

by Jeroen van den Enden

2.2.1

The Requires

The Development Requires

by Jeroen van den Enden

2.2.0

The Requires

The Development Requires

by Jeroen van den Enden

2.1.4

The Requires

The Development Requires

by Jeroen van den Enden

2.1.3

The Requires

The Development Requires

by Jeroen van den Enden

2.1.2

The Requires

The Development Requires

by Jeroen van den Enden

2.1.1

The Requires

The Development Requires

by Jeroen van den Enden

2.1.0

The Requires

The Development Requires

by Jeroen van den Enden

2.0.11

The Requires

The Development Requires

by Jeroen van den Enden

2.0.10

The Requires

The Development Requires

by Jeroen van den Enden

2.0.9

The Requires

The Development Requires

by Jeroen van den Enden

2.0.8

The Requires

The Development Requires

by Jeroen van den Enden

2.0.7

The Requires

The Development Requires

by Jeroen van den Enden

2.0.6

The Requires

The Development Requires

by Jeroen van den Enden

2.0.5

The Requires