class UninterpretedOption extends Message (View source)

A message representing a option the parser does not recognize. This only appears in options protos created by the compiler::Parser class.

DescriptorPool resolves these when building Descriptor objects. Therefore, options protos in descriptor objects (e.g. returned by Descriptor::options(), or produced by Descriptor::CopyTo()) will never have UninterpretedOptions in them.

Generated from protobuf message google.protobuf.UninterpretedOption

Properties

protected $identifier_value

The value of the uninterpreted option, in whatever type the tokenizer identified it as during parsing. Exactly one of these should be set.

protected $positive_int_value

Generated from protobuf field optional uint64 positive_int_value = 4;

protected $negative_int_value

Generated from protobuf field optional int64 negative_int_value = 5;

protected $double_value

Generated from protobuf field optional double double_value = 6;

protected $string_value

Generated from protobuf field optional bytes string_value = 7;

protected $aggregate_value

Generated from protobuf field optional string aggregate_value = 8;

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

Generated from protobuf field repeated .google.protobuf.UninterpretedOption.NamePart name = 2;

$this
setName(NamePart[]|RepeatedField $var)

Generated from protobuf field repeated .google.protobuf.UninterpretedOption.NamePart name = 2;

string
getIdentifierValue()

The value of the uninterpreted option, in whatever type the tokenizer identified it as during parsing. Exactly one of these should be set.

hasIdentifierValue()

No description

clearIdentifierValue()

No description

$this
setIdentifierValue(string $var)

The value of the uninterpreted option, in whatever type the tokenizer identified it as during parsing. Exactly one of these should be set.

int|string
getPositiveIntValue()

Generated from protobuf field optional uint64 positive_int_value = 4;

hasPositiveIntValue()

No description

clearPositiveIntValue()

No description

$this
setPositiveIntValue(int|string $var)

Generated from protobuf field optional uint64 positive_int_value = 4;

int|string
getNegativeIntValue()

Generated from protobuf field optional int64 negative_int_value = 5;

hasNegativeIntValue()

No description

clearNegativeIntValue()

No description

$this
setNegativeIntValue(int|string $var)

Generated from protobuf field optional int64 negative_int_value = 5;

float
getDoubleValue()

Generated from protobuf field optional double double_value = 6;

hasDoubleValue()

No description

clearDoubleValue()

No description

$this
setDoubleValue(float $var)

Generated from protobuf field optional double double_value = 6;

string
getStringValue()

Generated from protobuf field optional bytes string_value = 7;

hasStringValue()

No description

clearStringValue()

No description

$this
setStringValue(string $var)

Generated from protobuf field optional bytes string_value = 7;

string
getAggregateValue()

Generated from protobuf field optional string aggregate_value = 8;

hasAggregateValue()

No description

clearAggregateValue()

No description

$this
setAggregateValue(string $var)

Generated from protobuf field optional string aggregate_value = 8;

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

Generated from protobuf field repeated .google.protobuf.UninterpretedOption.NamePart name = 2;

Return Value

RepeatedField

$this setName(NamePart[]|RepeatedField $var)

Generated from protobuf field repeated .google.protobuf.UninterpretedOption.NamePart name = 2;

Parameters

NamePart[]|RepeatedField $var

Return Value

$this

string getIdentifierValue()

The value of the uninterpreted option, in whatever type the tokenizer identified it as during parsing. Exactly one of these should be set.

Generated from protobuf field optional string identifier_value = 3;

Return Value

string

hasIdentifierValue()

No description

clearIdentifierValue()

No description

$this setIdentifierValue(string $var)

The value of the uninterpreted option, in whatever type the tokenizer identified it as during parsing. Exactly one of these should be set.

Generated from protobuf field optional string identifier_value = 3;

Parameters

string $var

Return Value

$this

int|string getPositiveIntValue()

Generated from protobuf field optional uint64 positive_int_value = 4;

Return Value

int|string

hasPositiveIntValue()

No description

clearPositiveIntValue()

No description

$this setPositiveIntValue(int|string $var)

Generated from protobuf field optional uint64 positive_int_value = 4;

Parameters

int|string $var

Return Value

$this

int|string getNegativeIntValue()

Generated from protobuf field optional int64 negative_int_value = 5;

Return Value

int|string

hasNegativeIntValue()

No description

clearNegativeIntValue()

No description

$this setNegativeIntValue(int|string $var)

Generated from protobuf field optional int64 negative_int_value = 5;

Parameters

int|string $var

Return Value

$this

float getDoubleValue()

Generated from protobuf field optional double double_value = 6;

Return Value

float

hasDoubleValue()

No description

clearDoubleValue()

No description

$this setDoubleValue(float $var)

Generated from protobuf field optional double double_value = 6;

Parameters

float $var

Return Value

$this

string getStringValue()

Generated from protobuf field optional bytes string_value = 7;

Return Value

string

hasStringValue()

No description

clearStringValue()

No description

$this setStringValue(string $var)

Generated from protobuf field optional bytes string_value = 7;

Parameters

string $var

Return Value

$this

string getAggregateValue()

Generated from protobuf field optional string aggregate_value = 8;

Return Value

string

hasAggregateValue()

No description

clearAggregateValue()

No description

$this setAggregateValue(string $var)

Generated from protobuf field optional string aggregate_value = 8;

Parameters

string $var

Return Value

$this