class Annotation extends Message (View source)

Generated from protobuf message google.protobuf.GeneratedCodeInfo.Annotation

Properties

protected $source_file

Identifies the filesystem path to the original source .proto.

protected $begin

Identifies the starting offset in bytes in the generated code that relates to the identified object.

protected $end

Identifies the ending offset in bytes in the generated code that relates to the identified object. The end offset should be one past the last relevant byte (so the length of the text = end - begin).

protected $semantic

Generated from protobuf field optional .google.protobuf.GeneratedCodeInfo.Annotation.Semantic semantic = 5;

Methods

__construct($data = NULL)

Constructor.

readWrapperValue($member)

No description

from  Message
writeWrapperValue($member, $value)

No description

from  Message
readOneof($number)

No description

from  Message
hasOneof($number)

No description

from  Message
writeOneof($number, $value)

No description

from  Message
whichOneof($oneof_name)

No description

from  Message
null
clear()

Clear all containing fields.

from  Message
null
discardUnknownFields()

Clear all unknown fields previously parsed.

from  Message
null
mergeFrom(object $msg)

Merges the contents of the specified message into current message.

from  Message
null
mergeFromString(string $data)

Parses a protocol buffer contained in a string.

from  Message
null
mergeFromJsonString(string $data, bool $ignore_unknown = false)

Parses a json string to protobuf message.

from  Message
parseFromStream($input)

No description

from  Message
null
mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

from  Message
mergeFromJsonArray($array, $ignore_unknown)

No description

from  Message
parseFromJsonStream($input, $ignore_unknown)

No description

from  Message
serializeToStream($output)

No description

from  Message
serializeToJsonStream($output)

No description

from  Message
string
serializeToString()

Serialize the message to string.

from  Message
string
serializeToJsonString($options = 0)

Serialize the message to json string.

from  Message
byteSize()

No description

from  Message
jsonByteSize($options = 0)

No description

from  Message
__debugInfo()

No description

from  Message
RepeatedField<int>
getPath()

Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path.

$this
setPath(int[] $var)

Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path.

string
getSourceFile()

Identifies the filesystem path to the original source .proto.

hasSourceFile()

No description

clearSourceFile()

No description

$this
setSourceFile(string $var)

Identifies the filesystem path to the original source .proto.

int
getBegin()

Identifies the starting offset in bytes in the generated code that relates to the identified object.

hasBegin()

No description

clearBegin()

No description

$this
setBegin(int $var)

Identifies the starting offset in bytes in the generated code that relates to the identified object.

int
getEnd()

Identifies the ending offset in bytes in the generated code that relates to the identified object. The end offset should be one past the last relevant byte (so the length of the text = end - begin).

hasEnd()

No description

clearEnd()

No description

$this
setEnd(int $var)

Identifies the ending offset in bytes in the generated code that relates to the identified object. The end offset should be one past the last relevant byte (so the length of the text = end - begin).

int
getSemantic()

Generated from protobuf field optional .google.protobuf.GeneratedCodeInfo.Annotation.Semantic semantic = 5;

hasSemantic()

No description

clearSemantic()

No description

$this
setSemantic(int $var)

Generated from protobuf field optional .google.protobuf.GeneratedCodeInfo.Annotation.Semantic semantic = 5;

Details

__construct($data = NULL)

Constructor.

Parameters

$data

protected readWrapperValue($member)

No description

Parameters

$member

protected writeWrapperValue($member, $value)

No description

Parameters

$member
$value

protected readOneof($number)

No description

Parameters

$number

protected hasOneof($number)

No description

Parameters

$number

protected writeOneof($number, $value)

No description

Parameters

$number
$value

protected whichOneof($oneof_name)

No description

Parameters

$oneof_name

null clear()

Clear all containing fields.

Return Value

null

null discardUnknownFields()

Clear all unknown fields previously parsed.

Return Value

null

null mergeFrom(object $msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

Parameters

object $msg

Protobuf message to be merged from.

Return Value

null

null mergeFromString(string $data)

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

Parameters

string $data

Binary protobuf data.

Return Value

null

Exceptions

Exception

null mergeFromJsonString(string $data, bool $ignore_unknown = false)

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

Parameters

string $data

Json protobuf data.

bool $ignore_unknown

Return Value

null

Exceptions

Exception

parseFromStream($input)

No description

Parameters

$input

protected null mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

Parameters

array $array

An array containing message properties and values.

Return Value

null

protected mergeFromJsonArray($array, $ignore_unknown)

No description

Parameters

$array
$ignore_unknown

parseFromJsonStream($input, $ignore_unknown)

No description

Parameters

$input
$ignore_unknown

serializeToStream($output)

No description

Parameters

$output

serializeToJsonStream($output)

No description

Parameters

$output

string serializeToString()

Serialize the message to string.

Return Value

string

Serialized binary protobuf data.

string serializeToJsonString($options = 0)

Serialize the message to json string.

Parameters

$options

Return Value

string

Serialized json protobuf data.

byteSize()

No description

jsonByteSize($options = 0)

No description

Parameters

$options

__debugInfo()

No description

RepeatedField<int> getPath()

Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path.

Generated from protobuf field repeated int32 path = 1 [packed = true];

Return Value

RepeatedField<int>

$this setPath(int[] $var)

Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path.

Generated from protobuf field repeated int32 path = 1 [packed = true];

Parameters

int[] $var

Return Value

$this

string getSourceFile()

Identifies the filesystem path to the original source .proto.

Generated from protobuf field optional string source_file = 2;

Return Value

string

hasSourceFile()

No description

clearSourceFile()

No description

$this setSourceFile(string $var)

Identifies the filesystem path to the original source .proto.

Generated from protobuf field optional string source_file = 2;

Parameters

string $var

Return Value

$this

int getBegin()

Identifies the starting offset in bytes in the generated code that relates to the identified object.

Generated from protobuf field optional int32 begin = 3;

Return Value

int

hasBegin()

No description

clearBegin()

No description

$this setBegin(int $var)

Identifies the starting offset in bytes in the generated code that relates to the identified object.

Generated from protobuf field optional int32 begin = 3;

Parameters

int $var

Return Value

$this

int getEnd()

Identifies the ending offset in bytes in the generated code that relates to the identified object. The end offset should be one past the last relevant byte (so the length of the text = end - begin).

Generated from protobuf field optional int32 end = 4;

Return Value

int

hasEnd()

No description

clearEnd()

No description

$this setEnd(int $var)

Identifies the ending offset in bytes in the generated code that relates to the identified object. The end offset should be one past the last relevant byte (so the length of the text = end - begin).

Generated from protobuf field optional int32 end = 4;

Parameters

int $var

Return Value

$this

int getSemantic()

Generated from protobuf field optional .google.protobuf.GeneratedCodeInfo.Annotation.Semantic semantic = 5;

Return Value

int

hasSemantic()

No description

clearSemantic()

No description

$this setSemantic(int $var)

Generated from protobuf field optional .google.protobuf.GeneratedCodeInfo.Annotation.Semantic semantic = 5;

Parameters

int $var

Return Value

$this