‪Aspose.Barcode for PHP via Java  24.3
‪Aspose.Barcode for PHP via Java Generation and Recognition API docs
MaxiCodeCodetextMode2 Class Reference

Inherits MaxiCodeStructuredCodetext.

Public Member Functions

 __construct ()
 
 getMode ()
 
 getPostalCode ()
 
 getCountryCode ()
 
 setCountryCode (int $value)
 
 getServiceCategory ()
 
 setServiceCategory (int $value)
 
 getSecondMessage ()
 
 setSecondMessage (MaxiCodeSecondMessage $value)
 
 getConstructedCodetext ()
 
 initFromString (string $constructedCodetext)
 
 equals ($obj)
 
 getHashCode ()
 
 getMaxiCodeEncodeMode ()
 
 setMaxiCodeEncodeMode (int $value)
 
 getECIEncoding ()
 
 setECIEncoding (int $value)
 
 getBarcodeType ()
 
 getJavaClass ()
 
 getJavaClassName ()
 
 isNull ()
 
 printJavaClassName ()
 

Static Public Member Functions

static construct ($javaClass)
 

Public Attributes

const JAVA_CLASS_NAME = "com.aspose.mw.barcode.complexbarcode.MwMaxiCodeCodetextMode2"
 

Protected Member Functions

 init ()
 
 setJavaClass ($javaClass)
 

Detailed Description

Class for encoding and decoding the text embedded in the MaxiCode code for modes 2.

This sample shows how to encode and decode MaxiCode codetext for mode 2.

//Mode 2 with standart second message
$maxiCodeCodetext = new MaxiCodeCodetextMode2();
$maxiCodeCodetext->setPostalCode("524032140");
$maxiCodeCodetext->setCountryCode(056);
$maxiCodeCodetext->setServiceCategory(999);
$maxiCodeStandartSecondMessage = new MaxiCodeStandartSecondMessage();
$maxiCodeStandartSecondMessage->setMessage("Test message");
$maxiCodeCodetext->setSecondMessage($maxiCodeStandartSecondMessage);
$complexGenerator = new ComplexBarcodeGenerator($maxiCodeCodetext);
$complexGenerator->generateBarCodeImage(BarcodeImageFormat::PNG);
//Mode 2 with structured second message
$maxiCodeCodetext = new MaxiCodeCodetextMode2();
$maxiCodeCodetext->setPostalCode("524032140");
$maxiCodeCodetext->setCountryCode(056);
$maxiCodeCodetext->setServiceCategory(999);
$maxiCodeStructuredSecondMessage = new MaxiCodeStructuredSecondMessage();
$maxiCodeStructuredSecondMessage->add("634 ALPHA DRIVE");
$maxiCodeStructuredSecondMessage->add("PITTSBURGH");
$maxiCodeStructuredSecondMessage->add("PA");
$maxiCodeStructuredSecondMessage->setYear(99);
$maxiCodeCodetext->setSecondMessage(maxiCodeStructuredSecondMessage);
$complexGenerator = new ComplexBarcodeGenerator($maxiCodeCodetext);
$complexGenerator->generateBarCodeImage(BarcodeImageFormat::PNG);
//Decoding raw codetext with standart second message
$reader = new BarCodeReader("c:\\test.png", DecodeType::MAXI_CODE);
{
foreach($reader->readBarCodes() as $result)
{
$resultMaxiCodeCodetext = ComplexCodetextReader::tryDecodeMaxiCode($result->getExtended()->getMaxiCode()->getMaxiCodeMode(), $result->getCodeText());
if ($resultMaxiCodeCodetext instanceof MaxiCodeCodetextMode2)
{
$maxiCodeStructuredCodetext = $resultMaxiCodeCodetext;
print("BarCode Type: ".$maxiCodeStructuredCodetext->getPostalCode());
print("MaxiCode mode: ".$maxiCodeStructuredCodetext->getCountryCode());
print("BarCode CodeText: ".$maxiCodeStructuredCodetext->getServiceCategory());
if ($maxiCodeStructuredCodetext->getSecondMessage() instanceof MaxiCodeStandartSecondMessage){
$secondMessage = $maxiCodeStructuredCodetext->getSecondMessage();
print("Message: ".$secondMessage->getMessage());
}
}
}
}
//Decoding raw codetext with structured second message
$reader = new BarCodeReader("c:\\test.png", DecodeType::MAXI_CODE);
{
foreach($reader->readBarCodes() as $result)
{
$resultMaxiCodeCodetext = ComplexCodetextReader::tryDecodeMaxiCode($result->getExtended()->getMaxiCode()->getMaxiCodeMode(), $result->getCodeText());
if ($resultMaxiCodeCodetext instanceof MaxiCodeCodetextMode2){
$maxiCodeStructuredCodetext = $resultMaxiCodeCodetext;
print("BarCode Type: ".$maxiCodeStructuredCodetext->getPostalCode());
print("MaxiCode mode: ".$maxiCodeStructuredCodetext->getCountryCode());
print("BarCode CodeText: ".$maxiCodeStructuredCodetext->getServiceCategory());
if ($maxiCodeStructuredCodetext->getSecondMessage() instanceof MaxiCodeStructuredSecondMessage)
{
$secondMessage = $maxiCodeStructuredCodetext->getSecondMessage();
print("Message:");
for ($secondMessage->getIdentifiers() as $identifier){
print($identifier);
}
}
}
}
}

Constructor & Destructor Documentation

◆ __construct()

MaxiCodeCodetextMode2::__construct ( )

Member Function Documentation

◆ construct()

static MaxiCodeCodetextMode2::construct (   $javaClass)
static

◆ equals()

MaxiCodeStructuredCodetext::equals (   $obj)
inherited

Returns a value indicating whether this instance is equal to a specified MaxiCodeStructuredCodetext value.

Parameters
object$obj‪An MaxiCodeStructuredCodetext value to compare to this instance.
Returns
‪bool true if obj has the same value as this instance; otherwise, false.

◆ getBarcodeType()

MaxiCodeCodetext::getBarcodeType ( )
inherited

Gets barcode type.

Returns
‪Barcode type

Reimplemented from IComplexCodetext.

◆ getConstructedCodetext()

MaxiCodeStructuredCodetext::getConstructedCodetext ( )
inherited

Constructs codetext

Returns
‪string Constructed codetext

Reimplemented from IComplexCodetext.

◆ getCountryCode()

MaxiCodeStructuredCodetext::getCountryCode ( )
inherited

Identifies 3 digit country code.

◆ getECIEncoding()

MaxiCodeCodetext::getECIEncoding ( )
inherited

Gets ECI encoding. Used when MaxiCodeEncodeMode is AUTO.

◆ getHashCode()

MaxiCodeStructuredCodetext::getHashCode ( )
inherited

Returns the hash code for this instance.

Returns
‪int A 32-bit signed integer hash code.

◆ getJavaClass()

BaseJavaClass::getJavaClass ( )
inherited

◆ getJavaClassName()

BaseJavaClass::getJavaClassName ( )
inherited

◆ getMaxiCodeEncodeMode()

MaxiCodeCodetext::getMaxiCodeEncodeMode ( )
inherited

Gets a MaxiCode encode mode.

◆ getMode()

MaxiCodeCodetextMode2::getMode ( )

Gets MaxiCode mode.

Returns
‪int MaxiCode mode

Reimplemented from MaxiCodeCodetext.

◆ getPostalCode()

MaxiCodeStructuredCodetext::getPostalCode ( )
inherited

Identifies the postal code. Must be 9 digits in mode 2 or 6 alphanumeric symbols in mode 3.

◆ getSecondMessage()

MaxiCodeStructuredCodetext::getSecondMessage ( )
inherited

Identifies second message of the barcode.

◆ getServiceCategory()

MaxiCodeStructuredCodetext::getServiceCategory ( )
inherited

Identifies 3 digit service category.

◆ init()

MaxiCodeCodetextMode2::init ( )
protected

Reimplemented from MaxiCodeStructuredCodetext.

◆ initFromString()

MaxiCodeStructuredCodetext::initFromString ( string  $constructedCodetext)
inherited

Initializes instance from constructed codetext.

Parameters
string$constructedCodetext‪Constructed codetext.

Reimplemented from IComplexCodetext.

◆ isNull()

BaseJavaClass::isNull ( )
inherited

◆ printJavaClassName()

BaseJavaClass::printJavaClassName ( )
inherited

◆ setCountryCode()

MaxiCodeStructuredCodetext::setCountryCode ( int  $value)
inherited

Identifies 3 digit country code.

◆ setECIEncoding()

MaxiCodeCodetext::setECIEncoding ( int  $value)
inherited

Sets ECI encoding. Used when MaxiCodeEncodeMode is AUTO.

◆ setJavaClass()

BaseJavaClass::setJavaClass (   $javaClass)
protectedinherited

◆ setMaxiCodeEncodeMode()

MaxiCodeCodetext::setMaxiCodeEncodeMode ( int  $value)
inherited

Sets a MaxiCode encode mode.

◆ setSecondMessage()

MaxiCodeStructuredCodetext::setSecondMessage ( MaxiCodeSecondMessage  $value)
inherited

Identifies second message of the barcode.

◆ setServiceCategory()

MaxiCodeStructuredCodetext::setServiceCategory ( int  $value)
inherited

Identifies 3 digit service category.

Member Data Documentation

◆ JAVA_CLASS_NAME

const MaxiCodeCodetextMode2::JAVA_CLASS_NAME = "com.aspose.mw.barcode.complexbarcode.MwMaxiCodeCodetextMode2"