PHP Requires Chilkat v11.7.0+

Handle QR Code Errors

See more QR Code Examples

Demonstrates what happens when a request is refused. QrCode returns false and the response holds errors[0] with three members: a code that does not change between versions, the path of the request member at fault (a JSON Pointer such as /encoding/qr/version), and a message. Requests are checked strictly, so a misspelled option is an error rather than being silently ignored. LastErrorText has the same information in more detail. Chilkat2 PHP

<?php

use Chilkat2\Formats;
use Chilkat2\JsonObject;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$fmt = new Formats();
$json = new JsonObject();
$jsonOut = new JsonObject();

// 1. A misspelled option: "moduleSise" for "moduleSize".
$json->UpdateString('payload.text', 'https://www.chilkatsoft.com/');
$json->UpdateInt('render.moduleSise', 8);
try {
    $fmt->QrCode('generate', $json, $jsonOut);
} catch (\Chilkat2\Exception $e) {
    echo 'code: ', $jsonOut->StringOf('errors[0].code'), "\n";
    echo 'path: ', $jsonOut->StringOf('errors[0].path'), "\n";
    echo 'message: ', $jsonOut->StringOf('errors[0].message'), "\n";
}

// 2. A value out of range: QR versions are 1 to 40.
$json->Clear();
$json->UpdateString('payload.text', 'https://www.chilkatsoft.com/');
$json->UpdateInt('encoding.qr.version', 41);
try {
    $fmt->QrCode('generate', $json, $jsonOut);
} catch (\Chilkat2\Exception $e) {
    echo 'code: ', $jsonOut->StringOf('errors[0].code'), "\n";
    echo 'path: ', $jsonOut->StringOf('errors[0].path'), "\n";
    echo 'message: ', $jsonOut->StringOf('errors[0].message'), "\n";
}

// 3. Too much data: this text does not fit a version 1 symbol.
$json->Clear();
$json->UpdateString('payload.text', 'https://www.chilkatsoft.com/barcode_overview.asp');
$json->UpdateInt('encoding.qr.version', 1);
try {
    $fmt->QrCode('generate', $json, $jsonOut);
} catch (\Chilkat2\Exception $e) {
    echo 'code: ', $jsonOut->StringOf('errors[0].code'), "\n";
    echo 'path: ', $jsonOut->StringOf('errors[0].path'), "\n";
    echo 'message: ', $jsonOut->StringOf('errors[0].message'), "\n";
}

// A program can act on the code.
if ($jsonOut->StringOf('errors[0].code') === 'capacityExceeded') {
    echo "The text is too long for the symbol size allowed.\n";
}

// Sample output:

// code: unknownOption
// path: /render/moduleSise
// message: unknown option
// code: outOfRange
// path: /encoding/qr/version
// message: the value is out of range
// code: capacityExceeded
// path: /payload
// message: the payload does not fit the requested QR version at the requested error-correction level
// The text is too long for the symbol size allowed.