case_class_server/vendor/2amigos/qrcode-library/docs/index.md

Qrcode Library

The library provides developers with the tools to generate Qr codes with ease. It is a total refactored version of the previous named yii2-qrcode-helper which was based on the ported PHP version of the libqrencode C library.

This new version is highly inspired by the great work of BaconQrCode, in fact, it uses a modified version of its code for the writers included on this package.

Getting Started

The preferred way to install this extension is through composer.

Either run

php composer.phar require 2amigos/qrcode-library:~1.1

or add

    "2amigos/qrcode-library": "~1.1"

Usage

The use of the library is quite easy when working as standalone. For example:

<?php 

use Da\QrCode\QrCode;

$qrCode = (new QrCode('This is my text'))
    ->setSize(250)
    ->setMargin(5)
    ->useForegroundColor(51, 153, 255);

// now we can display the qrcode in many ways
// saving the result to a file:

$qrCode->writeFile(__DIR__ . '/code.png'); // writer defaults to PNG when none is specified

// display directly to the browser 
header('Content-Type: '.$qrCode->getContentType());
echo $qrCode->writeString();

?> 

<?php 
// or even as data:uri url
echo '<img src"' . $qrCode->writeDataUri() . '">';
?>

In order to ease the task to write different formats into a QrCode, the library comes with a set of classes. These are:

• BookmarkFormat
• BtcFormat
• GeoFormat
• iCalFormat
• MailMessageFormat
• MailToFormat
• MeCardFormat
• MmsFormat
• PhoneFormat
• SmsFormat
• vCardFormat
• WifiFormat
• YoutubeFormat

Yii2

This library comes also with two special classes to specifically work with the Yii2 framework. These are:

• QrCodeComponent
• QrCodeAction

Helpful Guides

• Advanced Usage
• Working with QrCodeComponent and QrCodeAction

Contributing

• How to Contribute
• Clean Code

© 2amigos 2013-2017