YOURLS QR Code Plugin

Allows you to get the QR code by simply clicking on a button in the Admin area (or by adding .qr to the end of the short URL.) Can also optionally display a QR code in the share box.

Installation

Install via composer using the composer.json provided.

Move the seans-qrcode folder into the /users/plugins folder. Then, activate the plugin in the admin interface. That's all there is to it, but see Configuration below

Requirements

User must have YOURLS 1.5.1+ installed. Latest version is tested with YOURLS 1.8.2.

WARNING: Does not work with YOURLS 1.6.

In addition to the server requirements of YOURLS, make sure you follow the server requirements of PHP QR Code library.

If these requirements can't be met, but you can install and run YOURLS, try the Google Chart API QR Code Plugin from Ozh (YOURL's developer).

Configuration

The plugin requires no special configuration, but there are a few options that you can control by defining constants in user/config.php, e.g.

define("SEAN_QR_SCALE", 5);

SEAN_QR_SCALE

Interger. Default: 5.
The size of a QR code pixel (SVG, IMAGE_*), HTML -> via CSS

SEAN_QR_LOGO_SPACE

Interger. Default: 13.
The size in QR modules, multiply with QROptions::$scale for pixel size

SEAN_QR_ADD_TO_SHAREBOX

Boolean. Default: true.
Whether to include a QR code in the share boxes. Set to true to enable.

SEAN_QR_MARGIN

Interger. Default: 4.
The width of the margin (quiet zone) around the QR, in 'virtual pixels'. A value of 4 is generally recommended, but if you are using the QR code in a context where it is surrounded by white space anyway lower values may work fine.

Bonus

Works with YOURLS Case-Insensitive to generate smaller QR codes!

Credits

Main functionality of adding a QR code is borrowed from Ozh's orginal plugin code.

QR code generation made possible by chillerlan/php-qrcode