1. class
  2. storage_onestore_v3
  3. \
  4. Document

Document

class Document extends ProtocolMessage (View source)

Methods

string
serializeToString()

Serializes the message and return it as a string.

from ProtocolMessage
string
serializePartialToString()

Serializes a protocol buffer that might not have all of the required fields set.

from ProtocolMessage
parseFromString(string $s)

Fills the message with a protocol buffer parsed from the given input string.

from ProtocolMessage
parsePartialFromString(string $s)

Fills the message with a protocol buffer parsed from the given input string. Will not fail if the resulting protocol buffer is not fully initialized.

from ProtocolMessage
mergeFromString(string $s)

Like parseFromString, fills the message with a protocol buffer parsed from the given input string.

from ProtocolMessage
mergePartialFromString(string $s)

Like parsePartialFromString, fills the message with a protocol buffer parsed from the given input string. Will not fail if the resulting protocol buffer is not fully initialized.

from ProtocolMessage
copyFrom(mixed $pb)

Copies data from another protocol buffer into this protocol buffer.

from ProtocolMessage
bool
isInitialized()

Checks if this protocol message has all of the requried fields initialized.

from ProtocolMessage
checkInitialized()

No description

tryMerge($d)

No description

outputPartial($out)

No description

byteSizePartial()

No description

clear()

No description

mergeFrom($x)

No description

equals($x)

No description

shortDebugString($prefix = "")

No description

static 
debugFormatString($value)

Format protocol buffer as a text string for debugging.

from ProtocolMessage
static 
debugFormatDouble($value)

No description

from ProtocolMessage
static 
lengthVarUint64($value)

No description

from ProtocolMessage
static 
lengthVarInt64($value)

No description

from ProtocolMessage
static 
lengthVarInt32($value)

No description

from ProtocolMessage
static 
lengthString($len)

No description

from ProtocolMessage
static 
debugFormatBool($b)

No description

from ProtocolMessage
static 
debugFormatFloat($value)

No description

from ProtocolMessage
static 
debugFormatFixed32($value)

No description

from ProtocolMessage
static 
debugFormatFixed64($value)

No description

from ProtocolMessage
static 
debugFormatInt32($value)

No description

from ProtocolMessage
static 
debugFormatInt64($value)

No description

from ProtocolMessage
checkProtoArray($arr)

No description

from ProtocolMessage
static bool
integerEquals(int $a, int $b)

Checks if two integers are equal.

from ProtocolMessage
getId()

No description

setId($val)

No description

clearId()

No description

hasId()

No description

getLanguage()

No description

setLanguage($val)

No description

clearLanguage()

No description

hasLanguage()

No description

getFieldSize()

No description

getFieldList()

No description

mutableField($idx)

No description

getField($idx)

No description

addField()

No description

clearField()

No description

getOrderId()

No description

setOrderId($val)

No description

clearOrderId()

No description

hasOrderId()

No description

getStorage()

No description

setStorage($val)

No description

clearStorage()

No description

hasStorage()

No description

getFacetSize()

No description

getFacetList()

No description

mutableFacet($idx)

No description

getFacet($idx)

No description

addFacet()

No description

clearFacet()

No description

Details

in ProtocolMessage at line 39
string serializeToString()

Serializes the message and return it as a string.

Return Value

string The serialized protocol buffer.

Exceptions

ProtocolBufferEncodeError If the protocol buffer is not initialized.

in ProtocolMessage at line 54
string serializePartialToString()

Serializes a protocol buffer that might not have all of the required fields set.

Return Value

string The serialized protocol buffer.

in ProtocolMessage at line 77
parseFromString(string $s)

Fills the message with a protocol buffer parsed from the given input string.

Parameters

string $s The string containing a serialized protocol buffer.

Exceptions

ProtocolBufferDecodeError If the result message is not correctly initialized.

in ProtocolMessage at line 92
parsePartialFromString(string $s)

Fills the message with a protocol buffer parsed from the given input string. Will not fail if the resulting protocol buffer is not fully initialized.

Parameters

string $s The string containing a serialized protocol buffer.

in ProtocolMessage at line 108
mergeFromString(string $s)

Like parseFromString, fills the message with a protocol buffer parsed from the given input string.

Parameters

string $s The string containing a serialized protocol buffer.

Exceptions

ProtocolBufferDecodeError If the result message is not correctly initialized.

in ProtocolMessage at line 128
mergePartialFromString(string $s)

Like parsePartialFromString, fills the message with a protocol buffer parsed from the given input string. Will not fail if the resulting protocol buffer is not fully initialized.

Parameters

string $s The string containing a serialized protocol buffer.

in ProtocolMessage at line 140
copyFrom(mixed $pb)

Copies data from another protocol buffer into this protocol buffer.

Parameters

mixed $pb The protocol buffer to copy from.

in ProtocolMessage at line 154
bool isInitialized()

Checks if this protocol message has all of the requried fields initialized.

Return Value

bool true if all fields are initialized, false otherwise.

at line 1654
checkInitialized()

at line 1614
tryMerge($d)

Parameters

$d

at line 1584
outputPartial($out)

Parameters

$out

at line 1554
byteSizePartial()

at line 1546
clear()

at line 1663
mergeFrom($x)

Parameters

$x

at line 1684
equals($x)

Parameters

$x

at line 1704
shortDebugString($prefix = "")

Parameters

$prefix

in ProtocolMessage at line 171
static protected debugFormatString($value)

Format protocol buffer as a text string for debugging.

Parameters

$value

in ProtocolMessage at line 181
static protected debugFormatDouble($value)

Parameters

$value

in ProtocolMessage at line 192
static protected lengthVarUint64($value)

Parameters

$value

in ProtocolMessage at line 227
static protected lengthVarInt64($value)

Parameters

$value

in ProtocolMessage at line 241
static protected lengthVarInt32($value)

Parameters

$value

in ProtocolMessage at line 245
static protected lengthString($len)

Parameters

$len

in ProtocolMessage at line 249
static protected debugFormatBool($b)

Parameters

$b

in ProtocolMessage at line 259
static protected debugFormatFloat($value)

Parameters

$value

in ProtocolMessage at line 263
static protected debugFormatFixed32($value)

Parameters

$value

in ProtocolMessage at line 268
static protected debugFormatFixed64($value)

Parameters

$value

in ProtocolMessage at line 290
static protected debugFormatInt32($value)

Parameters

$value

in ProtocolMessage at line 296
static protected debugFormatInt64($value)

Parameters

$value

in ProtocolMessage at line 303
protected checkProtoArray($arr)

Parameters

$arr

in ProtocolMessage at line 322
static protected bool integerEquals(int $a, int $b)

Checks if two integers are equal.

Parameters

int $a The first integer to compare.
int $b The second integer to compare.

Return Value

bool True if the intergers are equal, false otherwise.

at line 1416
getId()

at line 1422
setId($val)

Parameters

$val

at line 1426
clearId()

at line 1430
hasId()

at line 1433
getLanguage()

at line 1439
setLanguage($val)

Parameters

$val

at line 1443
clearLanguage()

at line 1447
hasLanguage()

at line 1450
getFieldSize()

at line 1453
getFieldList()

at line 1456
mutableField($idx)

Parameters

$idx

at line 1464
getField($idx)

Parameters

$idx

at line 1473
addField()

at line 1478
clearField()

at line 1481
getOrderId()

at line 1487
setOrderId($val)

Parameters

$val

at line 1491
clearOrderId()

at line 1495
hasOrderId()

at line 1498
getStorage()

at line 1504
setStorage($val)

Parameters

$val

at line 1508
clearStorage()

at line 1512
hasStorage()

at line 1515
getFacetSize()

at line 1518
getFacetList()

at line 1521
mutableFacet($idx)

Parameters

$idx

at line 1529
getFacet($idx)

Parameters

$idx

at line 1538
addFacet()

at line 1543
clearFacet()