Set Barcode Source

To perform barcode recognition using the Aspose.BarCode.Cloud SDK for PHP, you need to set the source of the barcode image. Methods of this SDK support loading barcode images from multiple sources, such as file URL, SplFileObject, and base64 encoded data. This guide provides detailed examples on how to set barcode image source through different API methods.

Supported Barcode Image Formats

  • JPEG
  • TIFF
  • PNG
  • BMP
  • GIF

Supported Barcode Source Formats

  • File URL: Link directly to an image URL.
  • SplFileObject: The image file for processing.
  • Base64 Encoded Image: Convert the image to a base64 encoded string for secure transfer.

Examples for ScanApi

  • Using GET Request with File URL
<?php

use Aspose\BarCode\Configuration;
use Aspose\BarCode\ScanApi;
use Aspose\BarCode\Requests\ScanRequestWrapper;

require_once 'vendor/autoload.php';

function makeConfiguration()
{
    $config = new Configuration();

    $envToken = getenv('TEST_CONFIGURATION_ACCESS_TOKEN');
    if (empty($envToken)) {
        $config->setClientId("Client Id from https://dashboard.aspose.cloud/applications");
        $config->setClientSecret("Client Secret from https://dashboard.aspose.cloud/applications");
    } else {
        $config->setAccessToken($envToken);
    }

    return $config;
}

function main()
{
    $scanApi = new ScanApi(null, makeConfiguration());

    $request = new ScanRequestWrapper("https://products.aspose.app/barcode/scan/img/how-to/scan/step2.png");
    $result = $scanApi->scan($request);

    echo sprintf(
        "File '%s' recognized, result: '%s'\n",
        "https://products.aspose.app/barcode/scan/img/how-to/scan/step2.png",
        $result->getBarcodes()[0]->getBarcodeValue()
    );
}

main();
  • Using POST Request with Base64 Encoded Image
<?php

use Aspose\BarCode\Configuration;
use Aspose\BarCode\ScanApi;
use Aspose\BarCode\Model\ScanBase64Request;
use Aspose\BarCode\Requests\ScanBase64RequestWrapper;

require_once 'vendor/autoload.php';

function makeConfiguration()
{
    $config = new Configuration();

    $envToken = getenv('TEST_CONFIGURATION_ACCESS_TOKEN');
    if (empty($envToken)) {
        $config->setClientId("Client Id from https://dashboard.aspose.cloud/applications");
        $config->setClientSecret("Client Secret from https://dashboard.aspose.cloud/applications");
    } else {
        $config->setAccessToken($envToken);
    }

    return $config;
}

function main()
{
    $scanApi = new ScanApi(null, makeConfiguration());

    $fileName = __DIR__ . '/../testdata/Qr.png';
    $imageBytes = file_get_contents($fileName);
    $imageBase64 = base64_encode($imageBytes);

    $base64Request = new ScanBase64Request([
        'file_base64' => $imageBase64
    ]);

    $request = new ScanBase64RequestWrapper($base64Request);

    $result = $scanApi->scanBase64($request);

    echo sprintf(
        "File '%s' recognized, result: '%s'\n",
        $fileName,
        $result->getBarcodes()[0]->getBarcodeValue()
    );
}

main();
  • Using POST Request with File Stream
<?php

use Aspose\BarCode\Configuration;
use Aspose\BarCode\ScanApi;
use Aspose\BarCode\Requests\ScanMultipartRequestWrapper;

require_once 'vendor/autoload.php';

function makeConfiguration()
{
    $config = new Configuration();

    $envToken = getenv('TEST_CONFIGURATION_ACCESS_TOKEN');
    if (empty($envToken)) {
        $config->setClientId("Client Id from https://dashboard.aspose.cloud/applications");
        $config->setClientSecret("Client Secret from https://dashboard.aspose.cloud/applications");
    } else {
        $config->setAccessToken($envToken);
    }

    return $config;
}

function main()
{
    $scanApi = new ScanApi(null, makeConfiguration());

    $fileName = __DIR__ . '/../testdata/Qr.png';
    $file = new SplFileObject($fileName, 'rb');
    $request = new ScanMultipartRequestWrapper($file);
    
    $result = $scanApi->scanMultipart($request);
    $file = null;

    echo sprintf("File '%s' recognized, result: '%s'\n", $fileName, $result->getBarcodes()[0]->getBarcodeValue());
}

main();

Examples for RecognizeApi

  • Using GET Request with File URL
<?php

use Aspose\BarCode\Configuration;
use Aspose\BarCode\RecognizeApi;
use Aspose\BarCode\Model\DecodeBarcodeType;
use Aspose\BarCode\Requests\RecognizeRequestWrapper;

require_once 'vendor/autoload.php';

function makeConfiguration()
{
    $config = new Configuration();

    $envToken = getenv('TEST_CONFIGURATION_ACCESS_TOKEN');
    if (empty($envToken)) {
        $config->setClientId("Client Id from https://dashboard.aspose.cloud/applications");
        $config->setClientSecret("Client Secret from https://dashboard.aspose.cloud/applications");
    } else {
        $config->setAccessToken($envToken);
    }

    return $config;
}

function main()
{
    $recognizeApi = new RecognizeApi(null, makeConfiguration());

    $request = new RecognizeRequestWrapper(
        DecodeBarcodeType::QR,
        "https://products.aspose.app/barcode/scan/img/how-to/scan/step2.png"
    );

    $result = $recognizeApi->recognize($request);

    echo sprintf(
        "File '%s' recognized, result: '%s'\n",
        "step2.png",
        $result->getBarcodes()[0]->getBarcodeValue()
    );
}

main();
  • Using POST Request with Base64 Encoded Image
<?php

use Aspose\BarCode\Configuration;
use Aspose\BarCode\RecognizeApi;
use Aspose\BarCode\Model\{DecodeBarcodeType, RecognizeBase64Request, RecognitionMode};
use Aspose\BarCode\Requests\RecognizeBase64RequestWrapper;

require_once 'vendor/autoload.php';

function makeConfiguration()
{
    $config = new Configuration();

    $envToken = getenv('TEST_CONFIGURATION_ACCESS_TOKEN');
    if (empty($envToken)) {
        $config->setClientId("Client Id from https://dashboard.aspose.cloud/applications");
        $config->setClientSecret("Client Secret from https://dashboard.aspose.cloud/applications");
    } else {
        $config->setAccessToken($envToken);
    }

    return $config;
}

function main()
{
    $recognizeApi = new RecognizeApi(null, makeConfiguration());

    $fileName = __DIR__ . '/../testdata/pdf417Sample.png';
    $imageBytes = file_get_contents($fileName);
    $imageBase64 = base64_encode($imageBytes);

    $base64Request = new RecognizeBase64Request([
        'barcode_types' => [DecodeBarcodeType::Pdf417],
        'file_base64' => $imageBase64
    ]);

    $request = new RecognizeBase64RequestWrapper($base64Request);

    $result = $recognizeApi->recognizeBase64($request);

    echo sprintf(
        "File '%s' recognized, result: '%s'\n",
        $fileName,
        $result->getBarcodes()[0]->getBarcodeValue()
    );
}

main();
  • Using POST Request with File Stream
<?php

use Aspose\BarCode\Configuration;
use Aspose\BarCode\RecognizeApi;
use Aspose\BarCode\Model\DecodeBarcodeType;
use Aspose\BarCode\Requests\RecognizeMultipartRequestWrapper;

require_once 'vendor/autoload.php';

function makeConfiguration()
{
    $config = new Configuration();

    $envToken = getenv('TEST_CONFIGURATION_ACCESS_TOKEN');
    if (empty($envToken)) {
        $config->setClientId("Client Id from https://dashboard.aspose.cloud/applications");
        $config->setClientSecret("Client Secret from https://dashboard.aspose.cloud/applications");
    } else {
        $config->setAccessToken($envToken);
    }

    return $config;
}

function main()
{
    $recognizeApi = new RecognizeApi(null, makeConfiguration());

    $fileName = __DIR__ . '/../testdata/Qr.png';
   $file = new SplFileObject($fileName, 'rb');

    $request = new RecognizeMultipartRequestWrapper(
        DecodeBarcodeType::QR,
        $file
    );

    $result = $recognizeApi->recognizeMultipart($request);

    echo sprintf(
        "File '%s' recognized, result: '%s'\n",
        $fileName,
        $result->getBarcodes()[0]->getBarcodeValue()
    );

    $file = null;
}

main();

Conclusion

Using the Aspose.BarCode.Cloud SDK for .NET, you can easily load and recognize barcode images in file URL, SplFileObject, and base64 encoded formats.

Optimize your barcode recognition workflows by selecting the most appropriate method based on your specific image format and application requirements.