EPC Tag Data Standard

composer require kduma/epc-tds

# Ubuntu/Debian
sudo apt-get install php-gmp

# CentOS/RHEL
sudo yum install php-gmp

# macOS with Homebrew
brew install php@8.1
# GMP is typically included

use KDuma\EpcTds\TDS;

$epc = TDS::valueOf("3034257BF7194E4000001A85");
echo get_class($epc); // KDuma\EpcTds\Epc\Sgtin\Sgtin96

// Use interfaces for type checking
if ($epc instanceof SgtinInterface) {
    echo $epc->getGtin();
}

$epc = TDS::fromTagURI("urn:epc:tag:sgtin-96:3.0614141.812345.6789");
echo $epc->toHexString(); // 3074257BF7194E4000001A85

use KDuma\EpcTds\Epc\EpcInterface;

function processEpc(EpcInterface $epc): void {
    echo $epc->getType()->name;     // Type enum
    echo $epc->toTagURI();           // Tag URI
    echo $epc->toIdURI();            // ID URI
    echo $epc->getTotalBits();       // Bit length (96, 198, etc.)
    echo $epc->getHeader();          // Header value
    $clone = $epc->clone();          // Create copy
}

use KDuma\EpcTds\Epc\HasFilterInterface;

if ($epc instanceof HasFilterInterface) {
    $filter = $epc->getFilter();     // Get filter (0-7)
    $epc->setFilter(3);              // Set filter
}

use KDuma\EpcTds\Epc\HasPartitionInterface;

if ($epc instanceof HasPartitionInterface) {
    $partition = $epc->getPartition();  // Get partition (0-6)
    $epc->setPartition(5);              // Set partition
}

use KDuma\EpcTds\Epc\HasCompanyPrefixInterface;

if ($epc instanceof HasCompanyPrefixInterface) {
    $prefix = $epc->getCompanyPrefix();
    $epc->setCompanyPrefix(614141);
}

use KDuma\EpcTds\Epc\HasSerialInterface;

if ($epc instanceof HasSerialInterface) {
    $serial = $epc->getSerial();        // int or string
    $epc->setSerial(12345);             // For 96-bit
    $epc->setSerial("ABC123");          // For extended
}

use KDuma\EpcTds\Epc\HasBarcodeInterface;

if ($epc instanceof HasBarcodeInterface) {
    $barcode = $epc->toBarcode();       // GTIN, SSCC, etc.
}

use KDuma\EpcTds\TDS;
use KDuma\EpcTds\Epc\EpcInterface;
use KDuma\EpcTds\Epc\HasBarcodeInterface;
use KDuma\EpcTds\Epc\HasSerialInterface;
use KDuma\EpcTds\Epc\Sgtin\SgtinInterface;

// Decode unknown EPC type
$epc = TDS::valueOf("3034257BF7194E4000001A85");

// Work with base interface
function logEpc(EpcInterface $epc): void {
    echo "Type: " . $epc->getType()->name . "\n";
    echo "Tag URI: " . $epc->toTagURI() . "\n";
}

// Check for barcode support
if ($epc instanceof HasBarcodeInterface) {
    echo "Barcode: " . $epc->toBarcode() . "\n";
}

// Check for serial support
if ($epc instanceof HasSerialInterface) {
    echo "Serial: " . $epc->getSerial() . "\n";
}

// Type-specific operations
if ($epc instanceof SgtinInterface) {
    echo "GTIN: " . $epc->getGtin() . "\n";
    echo "Item Ref: " . $epc->getItemReference() . "\n";
}

use KDuma\EpcTds\Epc\HasCompanyPrefixInterface;

// Filter EPCs by company
function filterByCompany(array $epcs, int $companyPrefix): array {
    return array_filter($epcs, function(EpcInterface $epc) use ($companyPrefix) {
        return $epc instanceof HasCompanyPrefixInterface
            && $epc->getCompanyPrefix() === $companyPrefix;
    });
}

// Update all filters in a batch
function setAllFilters(array $epcs, int $filter): void {
    foreach ($epcs as $epc) {
        if ($epc instanceof HasFilterInterface) {
            $epc->setFilter($filter);
        }
    }
}

use KDuma\EpcTds\Epc\Sgtin\Sgtin96;

// Create new SGTIN-96
$sgtin = new Sgtin96();
$sgtin->setFilter(3)
      ->setPartition(5)
      ->setCompanyPrefix(614141)
      ->setItemReference(812345)
      ->setSerial(6789);

echo $sgtin->toHexString();  // 3074257BF7194E4000001A85
echo $sgtin->toTagURI();     // urn:epc:tag:sgtin-96:3.0614141.812345.6789
echo $sgtin->toBarcode();    // 00614141123452

// From hex
$sgtin = new Sgtin96("3074257BF7194E4000001A85");
echo $sgtin->getGtin();      // 00614141123452

// From barcode (GTIN-14)
$sgtin = new Sgtin96();
$sgtin->setPartition(5)
      ->setGtin("00614141123452")
      ->setSerial(6789);

use KDuma\EpcTds\Epc\Sgtin\Sgtin198;

$sgtin = new Sgtin198();
$sgtin->setFilter(3)
      ->setPartition(5)
      ->setCompanyPrefix(614141)
      ->setItemReference(812345)
      ->setSerial("ABC123");

echo $sgtin->toHexString();
echo $sgtin->getSerial();  // ABC123 (alphanumeric)

use KDuma\EpcTds\Epc\Sscc\Sscc96;

$sscc = new Sscc96();
$sscc->setFilter(3)
     ->setPartition(5)
     ->setCompanyPrefix(614141)
     ->setSerialReference(1234567890);

echo $sscc->toTagURI();   // urn:epc:tag:sscc-96:3.0614141.1234567890
echo $sscc->toBarcode();  // 106141411234567890 (18-digit SSCC)

// From SSCC barcode
$sscc = new Sscc96();
$sscc->setPartition(5)
     ->setSscc("106141411234567897");

use KDuma\EpcTds\Epc\Sgln\Sgln96;

$sgln = new Sgln96();
$sgln->setFilter(3)
     ->setPartition(5)
     ->setCompanyPrefix(614141)
     ->setLocationReference(12345)
     ->setExtension(5678);

echo $sgln->toTagURI();   // urn:epc:tag:sgln-96:3.0614141.12345.5678
echo $sgln->toBarcode();  // 0614141123452 (GLN-13)

use KDuma\EpcTds\Epc\Sgln\Sgln195;

$sgln = new Sgln195();
$sgln->setFilter(3)
     ->setPartition(5)
     ->setCompanyPrefix(614141)
     ->setLocationReference(12345)
     ->setExtension("ABC123");

echo $sgln->getExtension();  // ABC123 (alphanumeric)

use KDuma\EpcTds\Epc\Grai\Grai96;

$grai = new Grai96();
$grai->setFilter(3)
     ->setPartition(5)
     ->setCompanyPrefix(614141)
     ->setAssetType(12345)
     ->setSerial(6789);

echo $grai->toTagURI();   // urn:epc:tag:grai-96:3.0614141.12345.6789
echo $grai->toBarcode();  // 0614141123452 (GRAI without serial)

use KDuma\EpcTds\Epc\Grai\Grai170;

$grai = new Grai170();
$grai->setFilter(3)
     ->setPartition(5)
     ->setCompanyPrefix(614141)
     ->setAssetType(12345)
     ->setSerial("ABC123");

echo $grai->getSerial();  // ABC123 (alphanumeric)

use KDuma\EpcTds\Epc\Gid\Gid96;

$gid = new Gid96();
$gid->setManager(12345678)
    ->setClass(123456)
    ->setSerial(789012);

echo $gid->toTagURI();    // urn:epc:tag:gid-96:12345678.123456.789012
echo $gid->toHexString();

use KDuma\EpcTds\Epc\Giai\Giai96;

$giai = new Giai96();
$giai->setFilter(3)
     ->setPartition(5)
     ->setCompanyPrefix(614141)
     ->setAssetReference(123456789);

echo $giai->toTagURI();   // urn:epc:tag:giai-96:3.0614141.123456789

use KDuma\EpcTds\Epc\Giai\Giai202;

$giai = new Giai202();
$giai->setFilter(3)
     ->setPartition(5)
     ->setCompanyPrefix(614141)
     ->setAssetReference("ASSET-ABC-123");

echo $giai->getAssetReference();  // ASSET-ABC-123 (alphanumeric)

use KDuma\EpcTds\Epc\Gsrn\Gsrn96;

$gsrn = new Gsrn96();
$gsrn->setFilter(3)
     ->setPartition(5)
     ->setCompanyPrefix(614141)
     ->setServiceReference(1234567890);

echo $gsrn->toTagURI();   // urn:epc:tag:gsrn-96:3.0614141.1234567890
echo $gsrn->toBarcode();  // 061414112345678905 (GSRN-18)

use KDuma\EpcTds\Epc\Gdti\Gdti96;

$gdti = new Gdti96();
$gdti->setFilter(3)
     ->setPartition(5)
     ->setCompanyPrefix(614141)
     ->setDocumentType(12345)
     ->setSerial(6789012345);

echo $gdti->toTagURI();   // urn:epc:tag:gdti-96:3.0614141.12345.6789012345

use KDuma\EpcTds\Epc\Gdti\Gdti174;

$gdti = new Gdti174();
$gdti->setFilter(3)
     ->setPartition(5)
     ->setCompanyPrefix(614141)
     ->setDocumentType(12345)
     ->setSerial("DOC-ABC-123");

echo $gdti->getSerial();  // DOC-ABC-123 (alphanumeric)

use KDuma\EpcTds\Epc\Cpi\Cpi96;

$cpi = new Cpi96();
$cpi->setFilter(3)
    ->setPartition(5)
    ->setCompanyPrefix(614141)
    ->setComponentPartReference(123456)
    ->setSerial(789012);

echo $cpi->toTagURI();   // urn:epc:tag:cpi-96:3.0614141.123456.789012

use KDuma\EpcTds\Epc\Sgcn\Sgcn96;

$sgcn = new Sgcn96();
$sgcn->setFilter(3)
     ->setPartition(5)
     ->setCompanyPrefix(614141)
     ->setCouponReference(12345)
     ->setSerial(6789012345);

echo $sgcn->toTagURI();   // urn:epc:tag:sgcn-96:3.0614141.12345.6789012345

// SGTIN-96 hierarchy:
// Sgtin96 -> AbstractSgtin -> AbstractStandardEpc -> AbstractEpc -> BitArray
//         implements SgtinInterface

// GID-96 hierarchy (different - no filter/barcode):
// Gid96 -> AbstractEpc -> BitArray
//       implements GidInterface

use KDuma\EpcTds\Epc\EpcInterface;
use KDuma\EpcTds\Epc\Sgtin\SgtinInterface;

// Accept any SGTIN variant (96 or 198-bit)
function processSgtin(SgtinInterface $sgtin): void {
    echo $sgtin->getGtin();
    echo $sgtin->getSerial();  // int or string depending on variant
}

// Accept any EPC type
function processAnyEpc(EpcInterface $epc): void {
    echo $epc->toTagURI();
}

use KDuma\EpcTds\Utils\BitArray;

$bits = new BitArray(96);
$bits->set(0x31, 0, 8);  // Set header
echo $bits->get(0, 8);   // Read header

use KDuma\EpcTds\Utils\Utils;

// Compute GS1 check digit
$checkDigit = Utils::computeCheckDigit("061414112345");
echo $checkDigit;  // 2

// Get maximum value for bit count
$max = Utils::getMaxValue(38);  // For 38-bit serial

use KDuma\EpcTds\TDS;
use KDuma\EpcTds\Epc\Sgtin\Sgtin96;

try {
    // Invalid hex string
    $epc = TDS::valueOf("INVALID");
} catch (InvalidArgumentException $e) {
    echo $e->getMessage();  // "INVALID is not a known EPC tag scheme"
}

try {
    // Value out of range
    $sgtin = new Sgtin96();
    $sgtin->setFilter(10);  // Filter must be 0-7
} catch (InvalidArgumentException $e) {
    echo $e->getMessage();  // "Value '10' out of range (min: 0, max: 7)"
}

try {
    // Invalid partition
    $sgtin = new Sgtin96();
    $sgtin->setPartition(10);  // Partition must be 0-6
} catch (InvalidArgumentException $e) {
    echo $e->getMessage();
}