PHPFUI/InstaDoc
 
Copied!

Generated from protobuf message google.protobuf.SourceCodeInfo.Location

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type int[] $path
      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).
@type int[] $span
      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.
@type string $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.
      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.
@type string $trailing_comments
@type string[] $leading_detached_comments
    }
public Google\Protobuf\Internal\Message::__debugInfo()
public Google\Protobuf\Internal\Message::byteSize()
 
  • ignore
public Google\Protobuf\Internal\Message::clear()
 

Clear all containing fields.

  • return null
public clearLeadingComments()
public clearTrailingComments()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public 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 string
public getLeadingDetachedComments()
 

Generated from protobuf field repeated string leading_detached_comments = 6;

  • return \RepeatedField<string>
public 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];

  • return \RepeatedField<int>
public 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 \RepeatedField<int>
public getTrailingComments()
 

Generated from protobuf field optional string trailing_comments = 4;

  • return string
public hasLeadingComments()
public hasTrailingComments()
public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)
 
  • ignore
public Google\Protobuf\Internal\Message::mergeFrom( $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.

  • param object $msg Protobuf message to be merged from.
  • return null
public Google\Protobuf\Internal\Message::mergeFromJsonString( $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.

  • param string $data Json protobuf data.
  • param bool $ignore_unknown
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::mergeFromString( $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.

  • param string $data Binary protobuf data.
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
 
  • ignore
public Google\Protobuf\Internal\Message::parseFromStream( $input)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)
 

Serialize the message to json string.

  • return string Serialized json protobuf data.
public Google\Protobuf\Internal\Message::serializeToStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToString()
 

Serialize the message to string.

  • return string Serialized binary protobuf data.
public 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;

  • param string $var
  • return $this
public setLeadingDetachedComments(Google\Protobuf\RepeatedField|array $var)
 

Generated from protobuf field repeated string leading_detached_comments = 6;

  • param string[] $var
  • return $this
public setPath(Google\Protobuf\RepeatedField|array $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];

  • param int[] $var
  • return $this
public setSpan(Google\Protobuf\RepeatedField|array $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];

  • param int[] $var
  • return $this
public setTrailingComments(string $var)
 

Generated from protobuf field optional string trailing_comments = 4;

  • param string $var
  • return $this
Properties
protected $leading_comments = NULL
 

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;

protected $trailing_comments = NULL
 

Generated from protobuf field optional string trailing_comments = 4;

Methods
protected Google\Protobuf\Internal\Message::hasOneof( $number)
protected Google\Protobuf\Internal\Message::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.

  • param array $array An array containing message properties and values.
  • return null
protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
protected Google\Protobuf\Internal\Message::readOneof( $number)
protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
Properties
private $leading_detached_comments = NULL
 

Generated from protobuf field repeated string leading_detached_comments = 6;

private $path = NULL
 

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];

private $span = NULL
 

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];

© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration