1. class
  2. google
  3. \
  4. net
  5. \
  6. ProtocolMessage

ProtocolMessage

abstract class ProtocolMessage (View source)

The parent class of all protocol buffers.

Subclasses are automatically generated by php protocol buffer compiler. Encoding methods can raise ProtocolBufferEncodeError if a value for an integer or long field is too large, or if any required field is not set. Decoding methods can raise ProtocolBufferDecodeError if they couldn't decode correctly, or the decoded message doesn't have all required fields.

Methods

string
serializeToString()

Serializes the message and return it as a string.

string
serializePartialToString()

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

parseFromString(string $s)

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

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.

mergeFromString(string $s)

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

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.

copyFrom(mixed $pb)

Copies data from another protocol buffer into this protocol buffer.

bool
isInitialized()

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

checkInitialized()

No description

tryMerge($decoder)

No description

outputPartial($encoder)

No description

byteSizePartial()

No description

clear()

No description

mergeFrom($proto)

No description

equals($proto)

No description

shortDebugString()

No description

static 
debugFormatString($value)

Format protocol buffer as a text string for debugging.

static 
debugFormatDouble($value)

No description

static 
lengthVarUint64($value)

No description

static 
lengthVarInt64($value)

No description

static 
lengthVarInt32($value)

No description

static 
lengthString($len)

No description

static 
debugFormatBool($b)

No description

static 
debugFormatFloat($value)

No description

static 
debugFormatFixed32($value)

No description

static 
debugFormatFixed64($value)

No description

static 
debugFormatInt32($value)

No description

static 
debugFormatInt64($value)

No description

checkProtoArray($arr)

No description

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

Checks if two integers are equal.

Details

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.

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.

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.

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.

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.

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.

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.

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 159
abstract checkInitialized()

at line 160
abstract tryMerge($decoder)

Parameters

$decoder

at line 161
abstract outputPartial($encoder)

Parameters

$encoder

at line 162
abstract byteSizePartial()

at line 163
abstract clear()

at line 164
abstract mergeFrom($proto)

Parameters

$proto

at line 165
abstract equals($proto)

Parameters

$proto

at line 166
abstract shortDebugString()

at line 171
static protected debugFormatString($value)

Format protocol buffer as a text string for debugging.

Parameters

$value

at line 181
static protected debugFormatDouble($value)

Parameters

$value

at line 192
static protected lengthVarUint64($value)

Parameters

$value

at line 227
static protected lengthVarInt64($value)

Parameters

$value

at line 241
static protected lengthVarInt32($value)

Parameters

$value

at line 245
static protected lengthString($len)

Parameters

$len

at line 249
static protected debugFormatBool($b)

Parameters

$b

at line 259
static protected debugFormatFloat($value)

Parameters

$value

at line 263
static protected debugFormatFixed32($value)

Parameters

$value

at line 268
static protected debugFormatFixed64($value)

Parameters

$value

at line 290
static protected debugFormatInt32($value)

Parameters

$value

at line 296
static protected debugFormatInt64($value)

Parameters

$value

at line 303
protected checkProtoArray($arr)

Parameters

$arr

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.