MaxiCodeStructuredCodetext Class Reference

Inherits MaxiCodeCodetext.

Inherited by MaxiCodeCodetextMode2, and MaxiCodeCodetextMode3.

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

Protected Member Functions
	init ()
	setJavaClass ($javaClass)

Detailed Description

Base class for encoding and decoding the text embedded in the MaxiCode code for modes 2 and 3.

This sample shows how to decode raw MaxiCode codetext to MaxiCodeStructuredCodetext instance.

$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 MaxiCodeStructuredCodetext)
    {
        $maxiCodeStructuredCodetext = $resultMaxiCodeCodetext;
        print("BarCode Type: ".$maxiCodeStructuredCodetext->getPostalCode());
        print("MaxiCode mode: ".$maxiCodeStructuredCodetext->getCountryCode());
        print("BarCode CodeText: ".$maxiCodeStructuredCodetext->getServiceCategory());
    }
}

Constructor & Destructor Documentation

__construct()

MaxiCodeStructuredCodetext::__construct

(

$javaClass

)

Reimplemented from IComplexCodetext.

Member Function Documentation

equals()

MaxiCodeStructuredCodetext::equals

(

$obj

)

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

(

)

Constructs codetext

Returns

‪string Constructed codetext

Reimplemented from IComplexCodetext.

getCountryCode()

MaxiCodeStructuredCodetext::getCountryCode

(

)

Identifies 3 digit country code.

getECIEncoding()

MaxiCodeCodetext::getECIEncoding ( )

inherited

Gets ECI encoding. Used when MaxiCodeEncodeMode is AUTO.

getHashCode()

MaxiCodeStructuredCodetext::getHashCode

(

)

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()

MaxiCodeCodetext::getMode ( )

abstractinherited

Gets MaxiCode mode.

Returns

‪MaxiCode mode

Reimplemented in MaxiCodeStandardCodetext, MaxiCodeCodetextMode3, and MaxiCodeCodetextMode2.

getPostalCode()

MaxiCodeStructuredCodetext::getPostalCode

(

)

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

getSecondMessage()

MaxiCodeStructuredCodetext::getSecondMessage

(

)

Identifies second message of the barcode.

getServiceCategory()

MaxiCodeStructuredCodetext::getServiceCategory

(

)

Identifies 3 digit service category.

init()

MaxiCodeStructuredCodetext::init ( )

protected

Reimplemented from BaseJavaClass.

Reimplemented in MaxiCodeCodetextMode3, and MaxiCodeCodetextMode2.

initFromString()

MaxiCodeStructuredCodetext::initFromString

(

string

$constructedCodetext

)

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

)

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

)

Identifies second message of the barcode.

setServiceCategory()

MaxiCodeStructuredCodetext::setServiceCategory

(

int

$value

)

Identifies 3 digit service category.