| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647 |
- # Quickstart
- ## Import the library
- Import the main class(es) and include the autoloader (if necessary):
- ```php
- use chillerlan\QRCode\{QRCode, QROptions};
- require_once __DIR__.'/../vendor/autoload.php';
- ```
- ## Create your first QR Code
- We want to encode this URI for a mobile authenticator into a QRcode image:
- ```php
- $data = 'otpauth://totp/test?secret=B3JX4VCVJDVNXNZ5&issuer=chillerlan.net';
- $qrcode = (new QRCode)->render($data);
- // default output is a base64 encoded data URI
- printf('<img src="%s" alt="QR Code" />', $qrcode);
- ```
- ### Configuration
- Configuration using `QROptions`:
- ```php
- $options = new QROptions;
- $options->version = 7;
- $options->outputBase64 = false; // output raw image instead of base64 data URI
- header('Content-type: image/svg+xml'); // the image type is SVG by default
- echo (new QRCode($options))->render($data);
- ```
- See [Advanced usage](../Usage/Advanced-usage.md) for a more in-depth usage guide
- and [configuration settings](../Usage/Configuration-settings.md) for a list of available options.
- Also, have a look [in the examples folder](https://github.com/chillerlan/php-qrcode/tree/main/examples) for some more usage examples.
- ## Notes
- The QR encoder, especially the subroutines for mask pattern testing, can cause high CPU load on increased matrix size.
- You can avoid a part of this load by choosing a fast output module, like SVG.
- Oh hey and don't forget to sanitize any user input!
|