class Location extends Message (View source)

Generated from protobuf message google.protobuf.SourceCodeInfo.Location

Properties

protected $leading_comments

If this SourceCodeInfo represents a complete declaration, these are any comments appearing before and after the declaration which appear to be attached to the declaration.

protected $trailing_comments

Generated from protobuf field optional string trailing_comments = 4;

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
clear()

Clear all containing fields.

from  Message
discardUnknownFields()

Clear all unknown fields previously parsed.

from  Message
mergeFrom(object $msg)

Merges the contents of the specified message into current message.

from  Message
mergeFromString(string $data)

Parses a protocol buffer contained in a string.

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

Parses a json string to protobuf message.

from  Message
parseFromStream($input)

No description

from  Message
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()

Serialize the message to json string.

from  Message
byteSize()

No description

from  Message
jsonByteSize()

No description

from  Message
getPath()

Identifies which part of the FileDescriptorProto was defined at this location.

$this
setPath(int[]|RepeatedField $var)

Identifies which part of the FileDescriptorProto was defined at this location.

getSpan()

Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column.

$this
setSpan(int[]|RepeatedField $var)

Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column.

string
getLeadingComments()

If this SourceCodeInfo represents a complete declaration, these are any comments appearing before and after the declaration which appear to be attached to the declaration.

hasLeadingComments()

No description

clearLeadingComments()

No description

$this
setLeadingComments(string $var)

If this SourceCodeInfo represents a complete declaration, these are any comments appearing before and after the declaration which appear to be attached to the declaration.

string
getTrailingComments()

Generated from protobuf field optional string trailing_comments = 4;

hasTrailingComments()

No description

clearTrailingComments()

No description

$this
setTrailingComments(string $var)

Generated from protobuf field optional string trailing_comments = 4;

getLeadingDetachedComments()

Generated from protobuf field repeated string leading_detached_comments = 6;

$this
setLeadingDetachedComments(string[]|RepeatedField $var)

Generated from protobuf field repeated string leading_detached_comments = 6;

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

clear()

Clear all containing fields.

discardUnknownFields()

Clear all unknown fields previously parsed.

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.

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.

Exceptions

Exception

mergeFromJsonString(string $data, $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.

$ignore_unknown

Exceptions

Exception

parseFromStream($input)

No description

Parameters

$input

protected 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.

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()

Serialize the message to json string.

Return Value

string

Serialized json protobuf data.

byteSize()

No description

jsonByteSize()

No description

RepeatedField getPath()

Identifies which part of the FileDescriptorProto was defined at this location.

Each element is a field number or an index. They form a path from the root FileDescriptorProto to the place where the definition occurs. For example, this path: [ 4, 3, 2, 7, 1 ] refers to: file.message_type(3) // 4, 3 .field(7) // 2, 7 .name() // 1 This is because FileDescriptorProto.message_type has field number 4: repeated DescriptorProto message_type = 4; and DescriptorProto.field has field number 2: repeated FieldDescriptorProto field = 2; and FieldDescriptorProto.name has field number 1: optional string name = 1; Thus, the above path gives the location of a field name. If we removed the last element: [ 4, 3, 2, 7 ] this path refers to the whole field declaration (from the beginning of the label to the terminating semicolon).

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

Return Value

RepeatedField

$this setPath(int[]|RepeatedField $var)

Identifies which part of the FileDescriptorProto was defined at this location.

Each element is a field number or an index. They form a path from the root FileDescriptorProto to the place where the definition occurs. For example, this path: [ 4, 3, 2, 7, 1 ] refers to: file.message_type(3) // 4, 3 .field(7) // 2, 7 .name() // 1 This is because FileDescriptorProto.message_type has field number 4: repeated DescriptorProto message_type = 4; and DescriptorProto.field has field number 2: repeated FieldDescriptorProto field = 2; and FieldDescriptorProto.name has field number 1: optional string name = 1; Thus, the above path gives the location of a field name. If we removed the last element: [ 4, 3, 2, 7 ] this path refers to the whole field declaration (from the beginning of the label to the terminating semicolon).

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

Parameters

int[]|RepeatedField $var

Return Value

$this

RepeatedField getSpan()

Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column.

These are packed into a single field for efficiency. Note that line and column numbers are zero-based -- typically you will want to add 1 to each before displaying to a user.

Generated from protobuf field repeated int32 span = 2 [packed = true];

Return Value

RepeatedField

$this setSpan(int[]|RepeatedField $var)

Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column.

These are packed into a single field for efficiency. Note that line and column numbers are zero-based -- typically you will want to add 1 to each before displaying to a user.

Generated from protobuf field repeated int32 span = 2 [packed = true];

Parameters

int[]|RepeatedField $var

Return Value

$this

string getLeadingComments()

If this SourceCodeInfo represents a complete declaration, these are any comments appearing before and after the declaration which appear to be attached to the declaration.

A series of line comments appearing on consecutive lines, with no other tokens appearing on those lines, will be treated as a single comment. leading_detached_comments will keep paragraphs of comments that appear before (but not connected to) the current element. Each paragraph, separated by empty lines, will be one comment element in the repeated field. Only the comment content is provided; comment markers (e.g. //) are stripped out. For block comments, leading whitespace and an asterisk will be stripped from the beginning of each line other than the first. Newlines are included in the output. Examples: optional int32 foo = 1; // Comment attached to foo. // Comment attached to bar. optional int32 bar = 2; optional string baz = 3; // Comment attached to baz. // Another line attached to baz. // Comment attached to moo. // // Another line attached to moo. optional double moo = 4; // Detached comment for corge. This is not leading or trailing comments // to moo or corge because there are blank lines separating it from // both. // Detached comment for corge paragraph 2. optional string corge = 5; /* Block comment attached

  • to corge. Leading asterisks
  • will be removed. */ /* Block comment attached to
  • grault. */ optional int32 grault = 6; // ignored detached comments.

Generated from protobuf field optional string leading_comments = 3;

Return Value

string

hasLeadingComments()

No description

clearLeadingComments()

No description

$this setLeadingComments(string $var)

If this SourceCodeInfo represents a complete declaration, these are any comments appearing before and after the declaration which appear to be attached to the declaration.

A series of line comments appearing on consecutive lines, with no other tokens appearing on those lines, will be treated as a single comment. leading_detached_comments will keep paragraphs of comments that appear before (but not connected to) the current element. Each paragraph, separated by empty lines, will be one comment element in the repeated field. Only the comment content is provided; comment markers (e.g. //) are stripped out. For block comments, leading whitespace and an asterisk will be stripped from the beginning of each line other than the first. Newlines are included in the output. Examples: optional int32 foo = 1; // Comment attached to foo. // Comment attached to bar. optional int32 bar = 2; optional string baz = 3; // Comment attached to baz. // Another line attached to baz. // Comment attached to moo. // // Another line attached to moo. optional double moo = 4; // Detached comment for corge. This is not leading or trailing comments // to moo or corge because there are blank lines separating it from // both. // Detached comment for corge paragraph 2. optional string corge = 5; /* Block comment attached

  • to corge. Leading asterisks
  • will be removed. */ /* Block comment attached to
  • grault. */ optional int32 grault = 6; // ignored detached comments.

Generated from protobuf field optional string leading_comments = 3;

Parameters

string $var

Return Value

$this

string getTrailingComments()

Generated from protobuf field optional string trailing_comments = 4;

Return Value

string

hasTrailingComments()

No description

clearTrailingComments()

No description

$this setTrailingComments(string $var)

Generated from protobuf field optional string trailing_comments = 4;

Parameters

string $var

Return Value

$this

RepeatedField getLeadingDetachedComments()

Generated from protobuf field repeated string leading_detached_comments = 6;

Return Value

RepeatedField

$this setLeadingDetachedComments(string[]|RepeatedField $var)

Generated from protobuf field repeated string leading_detached_comments = 6;

Parameters

string[]|RepeatedField $var

Return Value

$this