ECI
extends QRDataModeAbstract
in package
Adds an ECI Designator
ISO/IEC 18004:2000 8.4.1.1
Please note that you have to take care for the correct data encoding when adding with QRCode::add*Segment()
Table of Contents
- DATAMODE = \chillerlan\QRCode\Common\Mode::ECI
- $data : string
- The data to write
- $encoding : int
- The current ECI encoding id
- __construct() : mixed
- QRDataModeAbstract constructor.
- convertEncoding() : string
- encoding conversion helper
- decodeSegment() : string
- Reads and decodes the ECI designator including the following byte sequence
- getLengthInBits() : int
- parseValue() : ECICharset
- Reads and parses the value of an ECI designator
- validateString() : bool
- write() : QRDataModeInterface
- Writes an ECI designator to the bitbuffer
- getCharCount() : int
- returns the character count of the $data string
- getLengthBits() : int
- shortcut
Constants
DATAMODE
public
mixed
DATAMODE
= \chillerlan\QRCode\Common\Mode::ECI
Tags
Properties
$data
The data to write
protected
string
$data
$encoding
The current ECI encoding id
private
int
$encoding
Methods
__construct()
QRDataModeAbstract constructor.
public
__construct(int $encoding) : mixed
Parameters
- $encoding : int
Tags
Return values
mixed —convertEncoding()
encoding conversion helper
public
static convertEncoding(string $string) : string
Parameters
- $string : string
Tags
Return values
string —decodeSegment()
Reads and decodes the ECI designator including the following byte sequence
public
static decodeSegment(BitBuffer $bitBuffer, int $versionNumber) : string
Parameters
- $bitBuffer : BitBuffer
- $versionNumber : int
Tags
Return values
string —getLengthInBits()
public
getLengthInBits() : int
Tags
Return values
int —parseValue()
Reads and parses the value of an ECI designator
public
static parseValue(BitBuffer $bitBuffer) : ECICharset
Parameters
- $bitBuffer : BitBuffer
Tags
Return values
ECICharset —validateString()
public
static validateString(string $string) : bool
Parameters
- $string : string
Tags
Return values
bool —write()
Writes an ECI designator to the bitbuffer
public
write(BitBuffer $bitBuffer, int $versionNumber) : QRDataModeInterface
Parameters
- $bitBuffer : BitBuffer
- $versionNumber : int
Tags
Return values
QRDataModeInterface —getCharCount()
returns the character count of the $data string
protected
getCharCount() : int
Return values
int —getLengthBits()
shortcut
protected
static getLengthBits(int $versionNumber) : int
Parameters
- $versionNumber : int