API Documentation
\

\Mobi_Mtld_DA_Carrier_CarrierDataType

Carrier API specific data types. These are used to optimise the data in the data file.

These data types are internal and are mapped to the DataType::STRING_UTF8 that is exposed to the customer.

Summary

Methods
Properties
Constants
getName()
getBaseDataType()
No public properties found
BOOLEAN
BYTE
SHORT
INTEGER
LONG
FLOAT
DOUBLE
STRING
UNKNOWN
STRING_LEN_BYTE
STRING_LEN_SHORT
STRING_LEN_INT
STRING_1_BYTE_FIXED
STRING_2_BYTE_FIXED
STRING_3_BYTE_FIXED
STRING_4_BYTE_FIXED
STRING_5_BYTE_FIXED
No protected methods found
No protected properties found
N/A
No private methods found
$names
$START_STRING_ID
$END_STRING_ID
N/A

Constants

BOOLEAN

BOOLEAN = 0

Type boolean

BYTE

BYTE = 1

Type byte

SHORT

SHORT = 2

Type short int

INTEGER

INTEGER = 3

Type int

LONG

LONG = 4

Type long int

FLOAT

FLOAT = 5

Type float

DOUBLE

DOUBLE = 6

Type double

STRING

STRING = 7

Type string

UNKNOWN

UNKNOWN = 8

Unknown type

STRING_LEN_BYTE

STRING_LEN_BYTE = 100

internal API use

STRING_LEN_SHORT

STRING_LEN_SHORT = 101

internal API use

STRING_LEN_INT

STRING_LEN_INT = 102

internal API use

STRING_1_BYTE_FIXED

STRING_1_BYTE_FIXED = 103

internal API use

STRING_2_BYTE_FIXED

STRING_2_BYTE_FIXED = 104

internal API use

STRING_3_BYTE_FIXED

STRING_3_BYTE_FIXED = 105

internal API use

STRING_4_BYTE_FIXED

STRING_4_BYTE_FIXED = 106

internal API use

STRING_5_BYTE_FIXED

STRING_5_BYTE_FIXED = 107

internal API use

Properties

$names

$names :

Maps data types to data type names array {byte: string}

Type

$START_STRING_ID

$START_STRING_ID :

used to quickly find if an ID is a special string type. If we ever add additional IDs that are not sequential we will have to modify this.

Type

$END_STRING_ID

$END_STRING_ID :

used to quickly find if an ID is a special string type. If we ever add additional IDs that are not sequential we will have to modify this.

Type

Methods

getName()

getName(  $dataTypeID) : string

Get the name of a given data type.

Parameters

$dataTypeID
Warning: count(): Parameter must be an array or an object that implements Countable in /opt/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275 Warning: count(): Parameter must be an array or an object that implements Countable in /opt/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275

Returns

string —

The name of the data type.

getBaseDataType()

getBaseDataType(  $dataTypeID) : integer

Get the base data type for the given CarrierDataType. This essentially just converts the above special String types to the DataType.String type.

Parameters

$dataTypeID
Warning: count(): Parameter must be an array or an object that implements Countable in /opt/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275 Warning: count(): Parameter must be an array or an object that implements Countable in /opt/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275

Returns

integer —

Data type from DataType