PHPFUI/InstaDoc

Generated from protobuf message google.protobuf.GeneratedCodeInfo.Annotation

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type int[] $path
      Identifies the element in the original source .proto file. This field
      is formatted the same as SourceCodeInfo.Location.path.
@type string $source_file
      Identifies the filesystem path to the original source .proto.
@type int $begin
      Identifies the starting offset in bytes in the generated code
      that relates to the identified object.
@type int $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).
@type int $semantic

}

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

public clearEnd()

public clearSemantic()

public clearSourceFile()

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

Clear all unknown fields previously parsed.

return null

public 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 int

public 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 int

public 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 \RepeatedField<int>

public getSemantic()

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

return int

public getSourceFile()

Identifies the filesystem path to the original source .proto.

Generated from protobuf field optional string source_file = 2;

return string

public hasBegin()

public hasEnd()

public hasSemantic()

public hasSourceFile()

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 setBegin( $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;

param int $var
return $this

public setEnd( $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;

param int $var
return $this

public setPath( $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];

param int[] $var
return $this

public setSemantic( $var)

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

param int $var
return $this

public setSourceFile( $var)

Identifies the filesystem path to the original source .proto.

Generated from protobuf field optional string source_file = 2;

param string $var
return $this

Properties

protected $begin = NULL

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

Generated from protobuf field optional int32 begin = 3;

protected $end = NULL

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;

protected $semantic = NULL

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

protected $source_file = NULL

Identifies the filesystem path to the original source .proto.

Generated from protobuf field optional string source_file = 2;

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 $path = NULL

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