EnumOptions
class EnumOptions extends Message (View source)
Generated from protobuf message google.protobuf.EnumOptions
Properties
| protected | $allow_alias | Set this option to true to allow mapping different tag names to the same value. |
|
| protected | $deprecated | Is this enum deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum, or it will be completely ignored; in the very least, this is a formalization for deprecating enums. |
|
| protected deprecated | $deprecated_legacy_json_field_conflicts | Enable the legacy handling of JSON field name conflicts. This lowercases and strips underscored from the fields before comparison in proto3 only. |
|
| protected | $features | Any features defined in the specific edition. |
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.
Set this option to true to allow mapping different tag names to the same value.
No description
No description
Set this option to true to allow mapping different tag names to the same value.
Is this enum deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum, or it will be completely ignored; in the very least, this is a formalization for deprecating enums.
No description
No description
Is this enum deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum, or it will be completely ignored; in the very least, this is a formalization for deprecating enums.
Enable the legacy handling of JSON field name conflicts. This lowercases and strips underscored from the fields before comparison in proto3 only.
No description
No description
Enable the legacy handling of JSON field name conflicts. This lowercases and strips underscored from the fields before comparison in proto3 only.
Any features defined in the specific edition.
No description
No description
The parser stores options it doesn't recognize here. See above.
The parser stores options it doesn't recognize here. See above.
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
bool
getAllowAlias()
Set this option to true to allow mapping different tag names to the same value.
Generated from protobuf field optional bool allow_alias = 2;
hasAllowAlias()
No description
clearAllowAlias()
No description
$this
setAllowAlias(bool $var)
Set this option to true to allow mapping different tag names to the same value.
Generated from protobuf field optional bool allow_alias = 2;
bool
getDeprecated()
Is this enum deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum, or it will be completely ignored; in the very least, this is a formalization for deprecating enums.
Generated from protobuf field optional bool deprecated = 3 [default = false];
hasDeprecated()
No description
clearDeprecated()
No description
$this
setDeprecated(bool $var)
Is this enum deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum, or it will be completely ignored; in the very least, this is a formalization for deprecating enums.
Generated from protobuf field optional bool deprecated = 3 [default = false];
bool
getDeprecatedLegacyJsonFieldConflicts()
deprecated
deprecated
Enable the legacy handling of JSON field name conflicts. This lowercases and strips underscored from the fields before comparison in proto3 only.
The new behavior takes json_name into account and applies to proto2 as
well.
TODO Remove this legacy behavior once downstream teams have
had time to migrate.
Generated from protobuf field optional bool deprecated_legacy_json_field_conflicts = 6 [deprecated = true];
hasDeprecatedLegacyJsonFieldConflicts()
No description
clearDeprecatedLegacyJsonFieldConflicts()
No description
$this
setDeprecatedLegacyJsonFieldConflicts(bool $var)
deprecated
deprecated
Enable the legacy handling of JSON field name conflicts. This lowercases and strips underscored from the fields before comparison in proto3 only.
The new behavior takes json_name into account and applies to proto2 as
well.
TODO Remove this legacy behavior once downstream teams have
had time to migrate.
Generated from protobuf field optional bool deprecated_legacy_json_field_conflicts = 6 [deprecated = true];
FeatureSet|null
getFeatures()
Any features defined in the specific edition.
WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.
Generated from protobuf field optional .google.protobuf.FeatureSet features = 7;
hasFeatures()
No description
clearFeatures()
No description
$this
setFeatures(FeatureSet $var)
Any features defined in the specific edition.
WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.
Generated from protobuf field optional .google.protobuf.FeatureSet features = 7;
UninterpretedOption>
getUninterpretedOption()
The parser stores options it doesn't recognize here. See above.
Generated from protobuf field repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
$this
setUninterpretedOption(UninterpretedOption[] $var)
The parser stores options it doesn't recognize here. See above.
Generated from protobuf field repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;