Inherits BaseJavaClass.

Public Member Functions
	getPdf417CompactionMode ()

	setPdf417CompactionMode (int $value)

	getPdf417EncodeMode ()

	setPdf417EncodeMode (int $pdf417EncodeMode)

	getPdf417ErrorLevel ()

	setPdf417ErrorLevel (int $value)

	getPdf417Truncate ()

	setPdf417Truncate (bool $value)

	getColumns ()

	setColumns (int $value)

	getRows ()

	setRows (int $value)

	getAspectRatio ()

	setAspectRatio (float $value)

	getPdf417MacroFileID ()

	setPdf417MacroFileID (int $value)

	getPdf417MacroSegmentID ()

	setPdf417MacroSegmentID (int $value)

	getPdf417MacroSegmentsCount ()

	setPdf417MacroSegmentsCount (int $value)

	getPdf417MacroFileName ()

	setPdf417MacroFileName (string $value)

	getPdf417MacroTimeStamp ()

	setPdf417MacroTimeStamp (DateTime $value)

	getPdf417MacroSender ()

	setPdf417MacroSender (string $value)

	getPdf417MacroAddressee ()

	setPdf417MacroAddressee (string $value)

	getPdf417MacroFileSize ()

	setPdf417MacroFileSize (int $value)

	getPdf417MacroChecksum ()

	setPdf417MacroChecksum (int $value)

	getPdf417ECIEncoding ()

	setPdf417ECIEncoding (int $value)

	getPdf417MacroECIEncoding ()

	setPdf417MacroECIEncoding (int $value)

	getPdf417MacroTerminator ()

	setPdf417MacroTerminator (int $value)

	isReaderInitialization ()

	setReaderInitialization (bool $value)

	getMacroCharacters ()

	setMacroCharacters (int $value)

	isLinked ()

	setLinked (bool $value)

	isCode128Emulation ()

	setCode128Emulation (bool $value)

	toString ()

Public Member Functions inherited from BaseJavaClass
	__construct ($javaClass)

	getJavaClass ()

	getJavaClassName ()

	isNull ()

	printJavaClassName ()

Protected Member Functions
	init ()

Protected Member Functions inherited from BaseJavaClass
	setJavaClass ($javaClass)

Detailed Description

PDF417 parameters. Contains PDF417, MacroPDF417, MicroPDF417 and GS1MicroPdf417 parameters. MacroPDF417 requires two fields: Pdf417MacroFileID and Pdf417MacroSegmentID. All other fields are optional. MicroPDF417 in Structured Append mode (same as MacroPDF417 mode) requires two fields: Pdf417MacroFileID and Pdf417MacroSegmentID. All other fields are optional.

These samples show how to encode UCC/EAN-128 non Linked modes in GS1MicroPdf417

# Encodes GS1 UCC/EAN-128 non Linked mode 905 with AI 01 (GTIN)
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(01)12345678901231");
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach ($reader->readBarCodes() as $result)
   echo $result->getCodeText();

# Encodes GS1 UCC/EAN-128 non Linked modes 903, 904 with any AI
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(241)123456789012345(241)ABCD123456789012345");
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach ($reader->readBarCodes() as $result)
   echo $result->getCodeText();

Member Function Documentation

◆ getAspectRatio()

Pdf417Parameters::getAspectRatio ( )

Height/Width ratio of 2D BarCode module.

◆ getColumns()

Pdf417Parameters::getColumns ( )

Columns count.

◆ getMacroCharacters()

Pdf417Parameters::getMacroCharacters ( )

Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with MicroPdf417 and encodes 916 and 917 MicroPdf417 modes Default value: MacroCharacters.None.

These samples show how to encode Macro Characters in MicroPdf417
# Encodes MicroPdf417 with 05 Macro the string: "[)>\u001E05\u001Dabcde1234\u001E\u0004"
$generator = new BarcodeGenerator(EncodeTypes::MICRO_PDF_417, "abcde1234");
$generator->getParameters()->getBarcode()->getPdf417()->setMacroCharacters(MacroCharacter::MACRO_05);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
    echo $result->getCodeText();


# Encodes MicroPdf417 with 06 Macro the string: "[)>\u001E06\u001Dabcde1234\u001E\u0004"
$generator = new BarcodeGenerator(EncodeTypes::MICRO_PDF_417, "abcde1234");
$generator->getParameters()->getBarcode()->getPdf417()->setMacroCharacters(MacroCharacter::MACRO_06);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
    echo $result->getCodeText());

◆ getPdf417CompactionMode()

Pdf417Parameters::getPdf417CompactionMode ( )

Pdf417 symbology type of BarCode's compaction mode. Default value: Pdf417CompactionMode::AUTO.

Deprecated:: This property is obsolete and will be removed in future releases. Instead, use the Pdf417EncodeMode property.

◆ getPdf417ECIEncoding()

Pdf417Parameters::getPdf417ECIEncoding ( )

Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Not applied for Macro PDF417 text fields. Current implementation consists all well known charset encodings.

◆ getPdf417EncodeMode()

Pdf417Parameters::getPdf417EncodeMode ( )

Identifies Pdf417 encode mode. Default value: Auto.

◆ getPdf417ErrorLevel()

Pdf417Parameters::getPdf417ErrorLevel ( )

Gets Pdf417 symbology type of BarCode's error correction level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture.

◆ getPdf417MacroAddressee()

Pdf417Parameters::getPdf417MacroAddressee ( )

Gets macro Pdf417 barcode addressee name.

◆ getPdf417MacroChecksum()

Pdf417Parameters::getPdf417MacroChecksum ( )

Gets macro Pdf417 barcode checksum.

Returns: int checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial.

◆ getPdf417MacroECIEncoding()

Pdf417Parameters::getPdf417MacroECIEncoding ( )

Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.

◆ getPdf417MacroFileID()

Pdf417Parameters::getPdf417MacroFileID ( )

Getsmacro Pdf417 barcode's file ID. Used for MacroPdf417.

◆ getPdf417MacroFileName()

Pdf417Parameters::getPdf417MacroFileName ( )

Gets macro Pdf417 barcode file name.

Returns

◆ getPdf417MacroFileSize()

Pdf417Parameters::getPdf417MacroFileSize ( )

Gets macro Pdf417 file size.

Returns: int file size field contains the size in bytes of the entire source file.

◆ getPdf417MacroSegmentID()

Pdf417Parameters::getPdf417MacroSegmentID ( )

Gets macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.

◆ getPdf417MacroSegmentsCount()

Pdf417Parameters::getPdf417MacroSegmentsCount ( )

Gets macro Pdf417 barcode segments count.

◆ getPdf417MacroSender()

Pdf417Parameters::getPdf417MacroSender ( )

Gets macro Pdf417 barcode sender name.

◆ getPdf417MacroTerminator()

Pdf417Parameters::getPdf417MacroTerminator ( )

Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.

◆ getPdf417MacroTimeStamp()

Pdf417Parameters::getPdf417MacroTimeStamp ( )

Gets macro Pdf417 barcode time stamp.

◆ getPdf417Truncate()

Pdf417Parameters::getPdf417Truncate ( )

Whether Pdf417 symbology type of BarCode is truncated (to reduce space).

◆ getRows()

Pdf417Parameters::getRows ( )

Rows count.

◆ init()

Pdf417Parameters::init ( )

protected

Reimplemented from BaseJavaClass.

◆ isCode128Emulation()

Pdf417Parameters::isCode128Emulation ( )

Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and 909, also can encode 910 and 911 which just indicate that recognized MicroPdf417 can be interpret as Code 128

These samples show how to encode Code 128 emulation modes with FNC1 in second position and without. In this way MicroPdf417 can be decoded as Code 128 barcode

# Encodes MicroPdf417 in Code 128 emulation mode with FNC1 in second position and Application Indicator "a", mode 908.
$generator = new BarcodeGenerator(EncodeTypes::MICRO_PDF_417, "a\u001d1222322323");
$generator->getParameters()->getBarcode()->getPdf417()->setCode128Emulation(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
    echo $result->getCodeText() . " IsCode128Emulation:" . $result->getExtended()->getPdf417()->isCode128Emulation();

# Encodes MicroPdf417 in Code 128 emulation mode with FNC1 in second position and Application Indicator "99", mode 909.
$generator = new BarcodeGenerator(EncodeTypes::MICRO_PDF_417, "99\u001d1222322323");
$generator->getParameters()->getBarcode()->getPdf417()->setCode128Emulation(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
    echo $result->getCodeText() . " IsCode128Emulation:" . $result->getExtended()->getPdf417()->isCode128Emulation();

# Encodes MicroPdf417 in Code 128 emulation mode, modes 910, 911
$generator = new BarcodeGenerator(EncodeTypes::MICRO_PDF_417, "123456789012345678");
$generator->getParameters()->getBarcode()->getPdf417()->setCode128Emulation(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
    echo $result->getCodeText() . " IsCode128Emulation:" + result.Extended.Pdf417.IsCode128Emulation().toString());

◆ isLinked()

Pdf417Parameters::isLinked ( )

Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907, 912, 913, 914, 915 “Linked” UCC/EAN-128 modes With MicroPdf417 and Pdf417 symbologies encodes 918 linkage flag to associated linear component other than an EAN.UCC

These samples show how to encode "Linked" UCC/EAN-128 modes in GS1MicroPdf417 and Linkage Flag (918) in MicroPdf417 and Pdf417 barcodes
# Encodes GS1 Linked mode 912 with date field AI 11 (Production date) and AI 10 (Lot number)
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(11)991231(10)ABCD");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes GS1 Linked mode 912 with date field AI 13 (Packaging date) and AI 21 (Serial number)
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(13)991231(21)ABCD");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes GS1 Linked mode 912 with date field AI 15 (Sell-by date) and AI 10 (Lot number)
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(15)991231(10)ABCD");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes GS1 Linked mode 912 with date field AI 17 (Expiration date) and AI 21 (Serial number)
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(17)991231(21)ABCD");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes GS1 Linked mode 914 with AI 10 (Lot number)
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(10)ABCD12345");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes GS1 Linked mode 915 with AI 21 (Serial number)
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(21)ABCD12345");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes GS1 Linked modes 906, 907 with any AI
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(240)123456789012345");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes MicroPdf417 NON EAN.UCC Linked mode 918
$generator = new BarcodeGenerator(EncodeTypes::MICRO_PDF_417, "ABCDE123456789012345678");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes Pdf417 NON EAN.UCC Linked mode 918
$generator = new BarcodeGenerator(EncodeTypes::PDF_417, "ABCDE123456789012345678");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

◆ isReaderInitialization()

Pdf417Parameters::isReaderInitialization ( )

Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization

Returns

◆ setAspectRatio()

Pdf417Parameters::setAspectRatio ( float $value )

Height/Width ratio of 2D BarCode module.

◆ setCode128Emulation()

Pdf417Parameters::setCode128Emulation ( bool $value )

Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and 909, also can encode 910 and 911 which just indicate that recognized MicroPdf417 can be interpret as Code 128

These samples show how to encode Code 128 emulation modes with FNC1 in second position and without. In this way MicroPdf417 can be decoded as Code 128 barcode

# Encodes MicroPdf417 in Code 128 emulation mode with FNC1 in second position and Application Indicator "a", mode 908.
$generator = new BarcodeGenerator(EncodeTypes::MICRO_PDF_417, "a\u001d1222322323");
$generator->getParameters()->getBarcode()->getPdf417()->setCode128Emulation(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
    echo $result->getCodeText() . " IsCode128Emulation:" + result.Extended.Pdf417.IisCode128Emulation().toString());

# Encodes MicroPdf417 in Code 128 emulation mode with FNC1 in second position and Application Indicator "99", mode 909.
$generator = new BarcodeGenerator(EncodeTypes::MICRO_PDF_417, "99\u001d1222322323");
$generator->getParameters()->getBarcode()->getPdf417()->setCode128Emulation(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
    echo $result->getCodeText() . " IsCode128Emulation:" . $result->getExtended()->getPdf417()->isCode128Emulation();

# Encodes MicroPdf417 in Code 128 emulation mode, modes 910, 911
$generator = new BarcodeGenerator(EncodeTypes::MICRO_PDF_417, "123456789012345678");
$generator->getParameters()->getBarcode()->getPdf417()->setCode128Emulation(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
   echo $result->getCodeText() . " IsCode128Emulation:" . $result->getExtended()->getPdf417()->isCode128Emulation()));

◆ setColumns()

Pdf417Parameters::setColumns ( int $value )

Columns count.

◆ setLinked()

Pdf417Parameters::setLinked ( bool $value )

Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907, 912, 913, 914, 915 “Linked” UCC/EAN-128 modes With MicroPdf417 and Pdf417 symbologies encodes 918 linkage flag to associated linear component other than an EAN.UCC

These samples show how to encode "Linked" UCC/EAN-128 modes in GS1MicroPdf417 and Linkage Flag (918) in MicroPdf417 and Pdf417 barcodes

# Encodes GS1 Linked mode 912 with date field AI 11 (Production date) and AI 10 (Lot number)
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(11)991231(10)ABCD");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();
# Encodes GS1 Linked mode 912 with date field AI 13 (Packaging date) and AI 21 (Serial number)

$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(13)991231(21)ABCD");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes GS1 Linked mode 912 with date field AI 15 (Sell-by date) and AI 10 (Lot number)
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(15)991231(10)ABCD");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes GS1 Linked mode 912 with date field AI 17 (Expiration date) and AI 21 (Serial number)
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(17)991231(21)ABCD");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes GS1 Linked mode 914 with AI 10 (Lot number)
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(10)ABCD12345");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes GS1 Linked mode 915 with AI 21 (Serial number)
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(21)ABCD12345");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes GS1 Linked modes 906, 907 with any AI
$generator = new BarcodeGenerator(EncodeTypes::GS_1_MICRO_PDF_417, "(240)123456789012345");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::GS_1_MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes MicroPdf417 NON EAN.UCC Linked mode 918
$generator = new BarcodeGenerator(EncodeTypes::MICRO_PDF_417, "ABCDE123456789012345678");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

# Encodes Pdf417 NON EAN.UCC Linked mode 918
$generator = new BarcodeGenerator(EncodeTypes::PDF_417, "ABCDE123456789012345678");
$generator->getParameters()->getBarcode()->getPdf417()->setLinked(true);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::PDF_417);
foreach($reader->readBarCodes() as $result)
        echo $result->getCodeText() . " IsLinked:" . $result->getExtended()->getPdf417()->isLinked();

◆ setMacroCharacters()

Pdf417Parameters::setMacroCharacters ( int $value )

Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with MicroPdf417 and encodes 916 and 917 MicroPdf417 modes Default value: MacroCharacters.None.

These samples show how to encode Macro Characters in MicroPdf417
# Encodes MicroPdf417 with 05 Macro the string: "[)>\u001E05\u001Dabcde1234\u001E\u0004"
$generator = new BarcodeGenerator(EncodeTypes::MICRO_PDF_417, "abcde1234");
$generator->getParameters()->getBarcode()->getPdf417()->setMacroCharacters(MacroCharacter::MACRO_05);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
    echo $result->getCodeText();

# Encodes MicroPdf417 with 06 Macro the string: "[)>\u001E06\u001Dabcde1234\u001E\u0004"
$generator = new BarcodeGenerator(EncodeTypes::MICRO_PDF_417, "abcde1234");
$generator->getParameters()->getBarcode()->getPdf417()->setMacroCharacters(MacroCharacter::MACRO_06);
$reader = new BarCodeReader($generator->generateBarCodeImage(BarcodeImageFormat::PNG), null, DecodeType::MICRO_PDF_417);
foreach($reader->readBarCodes() as $result)
   echo $result->getCodeText();

◆ setPdf417CompactionMode()

Pdf417Parameters::setPdf417CompactionMode ( int $value )

Pdf417 symbology type of BarCode's compaction mode. Default value: Pdf417CompactionMode::AUTO.

Deprecated:: This property is obsolete and will be removed in future releases. Instead, use the Pdf417EncodeMode property.

◆ setPdf417ECIEncoding()

Pdf417Parameters::setPdf417ECIEncoding ( int $value )

Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Not applied for Macro PDF417 text fields. Current implementation consists all well known charset encodings.

◆ setPdf417EncodeMode()

Pdf417Parameters::setPdf417EncodeMode ( int $pdf417EncodeMode )

Identifies Pdf417 encode mode. Default value: Auto.

◆ setPdf417ErrorLevel()

Pdf417Parameters::setPdf417ErrorLevel ( int $value )

Sets Pdf417 symbology type of BarCode's error correction level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture.

◆ setPdf417MacroAddressee()

Pdf417Parameters::setPdf417MacroAddressee ( string $value )

Sets macro Pdf417 barcode addressee name.

◆ setPdf417MacroChecksum()

Pdf417Parameters::setPdf417MacroChecksum ( int $value )

Sets macro Pdf417 barcode checksum.

Parameters

int $value The checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial.

◆ setPdf417MacroECIEncoding()

Pdf417Parameters::setPdf417MacroECIEncoding ( int $value )

Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.

◆ setPdf417MacroFileID()

Pdf417Parameters::setPdf417MacroFileID ( int $value )

Sets macro Pdf417 barcode's file ID. Used for MacroPdf417.

◆ setPdf417MacroFileName()

Pdf417Parameters::setPdf417MacroFileName ( string $value )

Sets macro Pdf417 barcode file name.

Parameters

string $value

◆ setPdf417MacroFileSize()

Pdf417Parameters::setPdf417MacroFileSize ( int $value )

Sets macro Pdf417 file size.

Parameters

int $value The file size field contains the size in bytes of the entire source file.

◆ setPdf417MacroSegmentID()

Pdf417Parameters::setPdf417MacroSegmentID ( int $value )

Sets macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.

◆ setPdf417MacroSegmentsCount()

Pdf417Parameters::setPdf417MacroSegmentsCount ( int $value )

Sets macro Pdf417 barcode segments count.

◆ setPdf417MacroSender()

Pdf417Parameters::setPdf417MacroSender ( string $value )

Sets macro Pdf417 barcode sender name.

◆ setPdf417MacroTerminator()

Pdf417Parameters::setPdf417MacroTerminator ( int $value )

Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.

◆ setPdf417MacroTimeStamp()

Pdf417Parameters::setPdf417MacroTimeStamp ( DateTime $value )

Sets macro Pdf417 barcode time stamp.

◆ setPdf417Truncate()

Pdf417Parameters::setPdf417Truncate ( bool $value )

Whether Pdf417 symbology type of BarCode is truncated (to reduce space).

◆ setReaderInitialization()

Pdf417Parameters::setReaderInitialization ( bool $value )

Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization

Parameters

bool $value

◆ setRows()

Pdf417Parameters::setRows ( int $value )

Rows count.

◆ toString()

Pdf417Parameters::toString ( )

Returns a human-readable String representation of this Pdf417Parameters.

Returns: string that represents this Pdf417Parameters.

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ getAspectRatio()

◆ getColumns()

◆ getMacroCharacters()

◆ getPdf417CompactionMode()

◆ getPdf417ECIEncoding()

◆ getPdf417EncodeMode()

◆ getPdf417ErrorLevel()

◆ getPdf417MacroAddressee()

◆ getPdf417MacroChecksum()

◆ getPdf417MacroECIEncoding()

◆ getPdf417MacroFileID()

◆ getPdf417MacroFileName()

◆ getPdf417MacroFileSize()

◆ getPdf417MacroSegmentID()

◆ getPdf417MacroSegmentsCount()

◆ getPdf417MacroSender()

◆ getPdf417MacroTerminator()

◆ getPdf417MacroTimeStamp()

◆ getPdf417Truncate()

◆ getRows()

◆ init()

◆ isCode128Emulation()

◆ isLinked()

◆ isReaderInitialization()

◆ setAspectRatio()

◆ setCode128Emulation()

◆ setColumns()

◆ setLinked()

◆ setMacroCharacters()

◆ setPdf417CompactionMode()

◆ setPdf417ECIEncoding()

◆ setPdf417EncodeMode()

◆ setPdf417ErrorLevel()

◆ setPdf417MacroAddressee()

◆ setPdf417MacroChecksum()

◆ setPdf417MacroECIEncoding()

◆ setPdf417MacroFileID()

◆ setPdf417MacroFileName()

◆ setPdf417MacroFileSize()

◆ setPdf417MacroSegmentID()

◆ setPdf417MacroSegmentsCount()

◆ setPdf417MacroSender()

◆ setPdf417MacroTerminator()

◆ setPdf417MacroTimeStamp()

◆ setPdf417Truncate()

◆ setReaderInitialization()

◆ setRows()

◆ toString()