Skip to content

Api protocolbuffersmessage

Shuhei Tanuma edited this page Dec 25, 2013 · 12 revisions
Name
ProtocolBuffersMessage
Alias
ProtocolBuffers\Message
Visibility
Abstract
Implements
Iterator

Description

conventional class for generated message.

Basically, this class expects snake_case field name. but it also handle camel case field name. This class may misunderstood if case-sensitive same name fields (e,g userid, USERID, UserId) defined at the message. This is limitation of this class.

Constants

Methods

public ProtocolBuffers\Message::__construct([array $value])

Description
Parameters

$value:

Return Value

void:

Example

string public ProtocolBuffers\Message::serializeToString()

Description
Parameters
Return Value

string:

Example

mixed public static ProtocolBuffers\Message::parseFromString(string $raw_message)

Description
Parameters

$raw_message:

Return Value

mixed:

Example

void public ProtocolBuffers\Message::mergeFrom(mixed $message)

Description
Parameters

$message:

Return Value

void:

Example

mixed public ProtocolBuffers\Message::get(string $name)

Description
Parameters

$name:

Return Value

mixed:

Example

mixed public ProtocolBuffers\Message::has(string $name)

Description
Parameters

$name:

Return Value

mixed:

Example

void public ProtocolBuffers\Message::clear(string $name)

Description
Parameters

$name:

Return Value

void:

Example

void public ProtocolBuffers\Message::clearAll()

Description
Parameters
Return Value

void:

Example

mixed public ProtocolBuffers\Message::setFrom(array $values)

Description
Parameters

$values:

Return Value

mixed:

Example

void public ProtocolBuffers\Message::append(string $name, mixed $value)

Description
Parameters

$name: $value:

Return Value

void:

Example

void public ProtocolBuffers\Message::__call(string $name[, mixed $value])

Description
name
set<CamelCaseFieldName>($value)
get<CamelCaseFieldName>($value)
has<CamelCaseFieldName>($value)
clear<CamelCaseFieldName>()
append<CamelCaseFieldName>($value)
Parameters
Return Value

void:

Example

bool public ProtocolBuffers\Message::hasExtension(string $name)

Description
Parameters

$name:

Return Value

bool:

Example

mixed public ProtocolBuffers\Message::getExtension(string $name)

Description
Parameters

$name:

Return Value

mixed:

Example

void public ProtocolBuffers\Message::setExtension(string $name, mixed $extension)

Description
Parameters

$name:

Return Value

bool:

Example

void public ProtocolBuffers\Message::clearExtension(string $name)

Description
Parameters

$name:

Return Value

void:

Example

void public ProtocolBuffers\Message::discardUnknownFields()

Description
Parameters

$name:

Return Value

bool:

Example

void public ProtocolBuffers\Message::getUnknownFieldSet()

Description
Parameters

$name:

Return Value

bool:

Example
Clone this wiki locally