Generated from protobuf message google.protobuf.SourceCodeInfo.Location

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 

Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::clear()
     

    Clear all containing fields.

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

    Clear all unknown fields previously parsed.

    • return
    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 qux.
    //
    // Another line attached to qux.
    optional double qux = 4;
    // Detached comment for corge. This is not leading or trailing comments
    // to qux 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;

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

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

    public getTrailingComments()
     

    Generated from protobuf field optional string trailing_comments = 4;

    • return string
    public hasLeadingComments()
    public hasLeadingDetachedComments()
    public hasPath()
    public hasSpan()
    public hasTrailingComments()
    public Google\Protobuf\Internal\Message::jsonByteSize()
     
    • 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.

    • return
    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.

    • return
    • 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.

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

    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( $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 qux.
    //
    // Another line attached to qux.
    optional double qux = 4;
    // Detached comment for corge. This is not leading or trailing comments
    // to qux 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 $this
    public setLeadingDetachedComments( $var)
     

    Generated from protobuf field repeated string leading_detached_comments = 6;

    • return $this
    public setPath( $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. 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 $this
    public setSpan( $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];

    • return $this
    public setTrailingComments( $var)
     

    Generated from protobuf field optional string trailing_comments = 4;

    • return $this
    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.

    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 qux.
    //
    // Another line attached to qux.
    optional double qux = 4;
    // Detached comment for corge. This is not leading or trailing comments
    // to qux 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
     

    Generated from protobuf field optional string trailing_comments = 4;

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

    • return
    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 $has_leading_comments
    private $has_leading_detached_comments
    private $has_path
    private $has_span
    private $has_trailing_comments
    private $leading_detached_comments
     

    Generated from protobuf field repeated string leading_detached_comments = 6;

    private $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. 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
     

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

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $ignore_unknown, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     
    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array, $ignore_unknown)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     

    Tries to normalize the elements in $value into a provided protobuf
    wrapper type $class. If $value is any type other than array, we do
    not do any conversion, and instead rely on the existing protobuf
    type checking. If $value is an array, we process each element and
    try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       

      Tries to normalize $value into a provided protobuf wrapper type $class.

      If $value is any type other than an object, we attempt to construct an
      instance of $class and assign $value to it using the setValue method
      shared by all wrapper types.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         
        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         
        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         
        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         

        Tries to normalize the elements in $value into a provided protobuf
        wrapper type $class. If $value is any type other than array, we do
        not do any conversion, and instead rely on the existing protobuf
        type checking. If $value is an array, we process each element and
        try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           

          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             
            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only