Perl Requires Chilkat v11.7.0+

Validate a QR Code Request

See more QR Code Examples

Demonstrates the validate operation, which examines a request without producing anything. The scope says how far to look: definition checks the options, capacity also checks that the data fits a QR symbol, and layout also checks the rendered size against the limits. The response has a validationStatus of valid or invalid, a list of checks, and findings[] describing what is wrong. A request that cannot be understood at all, such as one with a misspelled option, still makes the call fail in the usual way. Perl

use chilkat();

$success = 0;

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

$fmt = chilkat::CkFormats->new();
$jsonOut = chilkat::CkJsonObject->new();

$json = chilkat::CkJsonObject->new();
$json->UpdateString("target","symbol");
$json->UpdateString("validation.scope","capacity");
$json->UpdateString("payload.text","https://www.chilkatsoft.com/barcode_overview.asp");

$success = $fmt->QrCode("validate",$json,$jsonOut);
if ($success == 0) {
    print $fmt->lastErrorText() . "\r\n";
    exit;
}

print "status: " . $jsonOut->stringOf("validationStatus") . "\r\n";
$n = $jsonOut->SizeOfArray("checks");
for ($i = 0; $i <= $n - 1; $i++) {
    $jsonOut->put_I($i);
    print "  " . $jsonOut->stringOf("checks[i].name") . ": " . $jsonOut->stringOf("checks[i].status") . "\r\n";
}

#  The same text does not fit version 2 at error-correction level H.
$json->UpdateInt("encoding.qr.maxVersion",2);
$json->UpdateString("encoding.qr.errorCorrection","H");

$success = $fmt->QrCode("validate",$json,$jsonOut);
if ($success == 0) {
    print $fmt->lastErrorText() . "\r\n";
    exit;
}

print "status: " . $jsonOut->stringOf("validationStatus") . "\r\n";
$n = $jsonOut->SizeOfArray("checks");
for ($i = 0; $i <= $n - 1; $i++) {
    $jsonOut->put_I($i);
    print "  " . $jsonOut->stringOf("checks[i].name") . ": " . $jsonOut->stringOf("checks[i].status") . "\r\n";
}

$n = $jsonOut->SizeOfArray("findings");
for ($i = 0; $i <= $n - 1; $i++) {
    $jsonOut->put_I($i);
    print "finding: " . $jsonOut->stringOf("findings[i].code") . " at " . $jsonOut->stringOf("findings[i].path") . "\r\n";
    print "  " . $jsonOut->stringOf("findings[i].message") . "\r\n";
}

#  Sample output:

#  status: valid
#    definition: passed
#    capacity: passed
#    layout: notApplicable
#  status: invalid
#    definition: passed
#    capacity: failed
#    layout: notApplicable
#  finding: capacityExceeded at /payload
#    the payload does not fit any admitted QR version at the selected error-correction level