Location
class Location extends Message (View source)
Generated from protobuf message google.protobuf.SourceCodeInfo.Location
Properties
| protected | $leading_comments | ||
| protected | $trailing_comments | Generated from protobuf field |
Methods
Constructor.
Merges the contents of the specified message into current message.
Parses a json string to protobuf message.
Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.
Identifies which part of the FileDescriptorProto was defined at this location.
Identifies which part of the FileDescriptorProto was defined at this location.
Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column.
Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column.
No description
No description
No description
No description
Generated from protobuf field optional string trailing_comments = 4;
No description
No description
Generated from protobuf field optional string trailing_comments = 4;
Generated from protobuf field repeated string leading_detached_comments = 6;
Generated from protobuf field repeated string leading_detached_comments = 6;
Details
__construct($data = NULL)
Constructor.
protected
readWrapperValue($member)
No description
protected
writeWrapperValue($member, $value)
No description
protected
readOneof($number)
No description
protected
hasOneof($number)
No description
protected
writeOneof($number, $value)
No description
protected
whichOneof($oneof_name)
No description
null
clear()
Clear all containing fields.
null
discardUnknownFields()
Clear all unknown fields previously parsed.
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.
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.
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.
parseFromStream($input)
No description
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.
protected
mergeFromJsonArray($array, $ignore_unknown)
No description
parseFromJsonStream($input, $ignore_unknown)
No description
serializeToStream($output)
No description
serializeToJsonStream($output)
No description
string
serializeToString()
Serialize the message to string.
string
serializeToJsonString($options = 0)
Serialize the message to json string.
byteSize()
No description
jsonByteSize($options = 0)
No description
__debugInfo()
No description
RepeatedField<int>
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 appears. 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];
$this
setPath(int[] $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 appears. 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];
RepeatedField<int>
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];
$this
setSpan(int[] $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];
getLeadingComments()
No description
hasLeadingComments()
No description
clearLeadingComments()
No description
setLeadingComments($var)
No description
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;
RepeatedField<string>
getLeadingDetachedComments()
Generated from protobuf field repeated string leading_detached_comments = 6;
$this
setLeadingDetachedComments(string[] $var)
Generated from protobuf field repeated string leading_detached_comments = 6;