Sample code for 30+ languages & platforms
PHP Requires Chilkat v11.7.0+

Get the Modules of a QR Code (Bit Matrix)

See more QR Code Examples

Demonstrates getting the QR code itself, as a grid of dark and light modules, to draw with something other than the built-in PNG and SVG output: on a canvas, in a PDF, on a display, or with a label printer language. With output.includeModuleData the response has symbols[0].moduleData, a bit matrix with one bit per module, each row starting on a new byte, most significant bit first, 1 for dark. The quiet zone is not part of the matrix. The example prints the symbol using two characters per module.

Chilkat PHP Downloads

Chilkat2 PHP
<?php

use Chilkat2\BinData;
use Chilkat2\Formats;
use Chilkat2\JsonObject;
use Chilkat2\StringBuilder;

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

$json = new JsonObject();
$json->UpdateString('payload.text', 'CHILKAT');
$json->UpdateBool('output.includeModuleData', true);

$fmt = new Formats();
$jsonOut = new JsonObject();
try {
    $fmt->QrCode('generate', $json, $jsonOut);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

$width = $jsonOut->IntOf('symbols[0].moduleData.width');
$height = $jsonOut->IntOf('symbols[0].moduleData.height');
$rowBytes = $jsonOut->IntOf('symbols[0].moduleData.rowBytes');
echo 'kind: ', $jsonOut->StringOf('symbols[0].moduleData.kind'), "\n";
echo 'modules: ', $width, ' x ', $height, ', ', $rowBytes, " bytes per row\n";

// The matrix is height rows of rowBytes bytes.
$bd = new BinData();
try {
    $bd->AppendEncoded($jsonOut->StringOf('symbols[0].moduleData.bytesBase64'), 'base64');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

$sbRow = new StringBuilder();
$b = 0;
$mask = 128;
for ($row = 0; $row < $height; $row++) {
    $sbRow->Clear();
    for ($col = 0; $col < $width; $col++) {
        // The module at (col,row) is a bit of the byte at (row * rowBytes) + (col / 8).
        // The leftmost module of each byte is its most significant bit.
        if (($col % 8) == 0) {
            $mask = 128;
        }

        $b = $bd->GetByte(($row * $rowBytes) + (intdiv($col, 8)));
        if (((intdiv($b, $mask)) % 2) == 1) {
            $sbRow->Append('##');
        } else {
            $sbRow->Append('  ');
        }

        $mask = intdiv($mask, 2);
    }

    echo $sbRow->GetAsString(), "\n";
}

// The same symbol as the PNG that the call also returned:

// image

// Sample output:

// kind: bitMatrix
// modules: 21 x 21, 3 bytes per row
// ##############              ##############
// ##          ##      ####    ##          ##
// ##  ######  ##  ##  ####    ##  ######  ##
// ##  ######  ##  ##          ##  ######  ##
// ##  ######  ##  ##  ##  ##  ##  ######  ##
// ##          ##  ####  ##    ##          ##
// ##############  ##  ##  ##  ##############
//                 ####
// ##  ##########      ####    ##########
//     ####          ##  ########    ######
// ####  ########    ####  ##  ####      ####
//       ##  ##      ############    ####  ##
//   ######  ####  ######  ##    ##  ##
//                 ##  ##  ##    ##  ##    ##
// ##############        ##  ##    ##      ##
// ##          ##  ##  ##        ######  ####
// ##  ######  ##  ####  ##  ##    ##
// ##  ######  ##  ##  ############    ##
// ##  ######  ##  ##      ##  ####  ##
// ##          ##    ##  ########          ##
// ##############  ##      ##      ######