Flow PHP

Format

FinalYes

Constants

DATETIME_IMMUTABLE  : int = 0x0
DATETIME_MUTABLE  : int = 0x1
FRAME_FOOTER  : int = 0x6
FRAME_HEADER_LENGTH  : int = 5
FRAME_PARTITIONS  : int = 0x3
FRAME_ROW  : int = 0x2
HEADER_LENGTH  : int = 6
KEY_INTEGER  : int = 0x0
KEY_STRING  : int = 0x1
MAGIC  : string = 'FLOE'
TAG_ARRAY  : int = 0x5
TAG_BOOLEAN  : int = 0x3
TAG_DATETIME  : int = 0x6
TAG_FLOAT  : int = 0x2
TAG_INTEGER  : int = 0x1
TAG_JSON  : int = 0x8
TAG_NULL  : int = 0x0
TAG_STRING  : int = 0x4
TAG_UUID  : int = 0x7
TRAILER_LENGTH  : int = 8
VALUE_ABSENT  : int = 0x3
VALUE_ABSENT_BYTE  : string = "\x03"
VALUE_NULL  : int = 0x0
VALUE_NULL_BYTE  : string = "\x00"
VALUE_NULL_WITH_META  : int = 0x2
VALUE_NULL_WITH_META_BYTE  : string = "\x02"
VALUE_PRESENT  : int = 0x1
VALUE_PRESENT_BYTE  : string = "\x01"
VALUE_PRESENT_WITH_META  : int = 0x4
VALUE_PRESENT_WITH_META_BYTE  : string = "\x04"
VERSION  : int = 0x1

Methods

frame()  : string
header()  : string
metadataBytes()  : string
parseTrailer()  : int
readMetadata()  : Metadata
trailer()  : string
validateCodecId()  : void
validateHeader()  : int

Constants

DATETIME_IMMUTABLE

public int DATETIME_IMMUTABLE = 0x0

DATETIME_MUTABLE

public int DATETIME_MUTABLE = 0x1

FRAME_FOOTER

public int FRAME_FOOTER = 0x6

FRAME_HEADER_LENGTH

public int FRAME_HEADER_LENGTH = 5

FRAME_PARTITIONS

public int FRAME_PARTITIONS = 0x3

FRAME_ROW

public int FRAME_ROW = 0x2

HEADER_LENGTH

public int HEADER_LENGTH = 6

KEY_INTEGER

public int KEY_INTEGER = 0x0

KEY_STRING

public int KEY_STRING = 0x1

MAGIC

public string MAGIC = 'FLOE'

TAG_ARRAY

public int TAG_ARRAY = 0x5

TAG_BOOLEAN

public int TAG_BOOLEAN = 0x3

TAG_DATETIME

public int TAG_DATETIME = 0x6

TAG_FLOAT

public int TAG_FLOAT = 0x2

TAG_INTEGER

public int TAG_INTEGER = 0x1

TAG_JSON

public int TAG_JSON = 0x8

TAG_NULL

public int TAG_NULL = 0x0

TAG_STRING

public int TAG_STRING = 0x4

TAG_UUID

public int TAG_UUID = 0x7

TRAILER_LENGTH

public int TRAILER_LENGTH = 8

VALUE_ABSENT

public int VALUE_ABSENT = 0x3

VALUE_ABSENT_BYTE

public string VALUE_ABSENT_BYTE = "\x03"

VALUE_NULL

public int VALUE_NULL = 0x0

VALUE_NULL_BYTE

public string VALUE_NULL_BYTE = "\x00"

VALUE_NULL_WITH_META

public int VALUE_NULL_WITH_META = 0x2

VALUE_NULL_WITH_META_BYTE

public string VALUE_NULL_WITH_META_BYTE = "\x02"

VALUE_PRESENT

public int VALUE_PRESENT = 0x1

VALUE_PRESENT_BYTE

public string VALUE_PRESENT_BYTE = "\x01"

VALUE_PRESENT_WITH_META

public int VALUE_PRESENT_WITH_META = 0x4

VALUE_PRESENT_WITH_META_BYTE

public string VALUE_PRESENT_WITH_META_BYTE = "\x04"

VERSION

public int VERSION = 0x1

Methods

frame()

public static frame(int $type, string $body) : string
Parameters
$type : int
$body : string
Return values
string

header()

public static header(int $flags) : string
Parameters
$flags : int
Return values
string

parseTrailer()

public static parseTrailer(string $bytes) : int
Parameters
$bytes : string
Tags
throws
FloeException
Return values
int —

footer JSON length

trailer()

public static trailer(int $footerLength) : string
Parameters
$footerLength : int
Return values
string

validateCodecId()

public static validateCodecId(int $codecId) : void
Parameters
$codecId : int
Tags
throws
FloeException

validateHeader()

public static validateHeader(string $bytes) : int
Parameters
$bytes : string
Tags
throws
FloeException
Return values
int —

header flags byte

On this page

Search results