EnumDescriptorProto
class EnumDescriptorProto extends Message (View source)
Describes an enum type.
Generated from protobuf message google.protobuf.EnumDescriptorProto
Properties
| protected | $name | Generated from protobuf field |
|
| protected | $options | Generated from protobuf field |
|
| protected | $visibility | Support for |
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.
Generated from protobuf field optional string name = 1;
No description
No description
Generated from protobuf field optional string name = 1;
Generated from protobuf field repeated .google.protobuf.EnumValueDescriptorProto value = 2;
Generated from protobuf field repeated .google.protobuf.EnumValueDescriptorProto value = 2;
Generated from protobuf field optional .google.protobuf.EnumOptions options = 3;
No description
No description
Generated from protobuf field optional .google.protobuf.EnumOptions options = 3;
Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap.
Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap.
Reserved enum value names, which may not be reused. A given name may only be reserved once.
Reserved enum value names, which may not be reused. A given name may only be reserved once.
Support for export and local keywords on enums.
No description
No description
Support for export and local keywords on enums.
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
string
getName()
Generated from protobuf field optional string name = 1;
hasName()
No description
clearName()
No description
$this
setName(string $var)
Generated from protobuf field optional string name = 1;
EnumValueDescriptorProto>
getValue()
Generated from protobuf field repeated .google.protobuf.EnumValueDescriptorProto value = 2;
$this
setValue(EnumValueDescriptorProto[] $var)
Generated from protobuf field repeated .google.protobuf.EnumValueDescriptorProto value = 2;
EnumOptions|null
getOptions()
Generated from protobuf field optional .google.protobuf.EnumOptions options = 3;
hasOptions()
No description
clearOptions()
No description
$this
setOptions(EnumOptions $var)
Generated from protobuf field optional .google.protobuf.EnumOptions options = 3;
EnumReservedRange>
getReservedRange()
Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap.
Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto.EnumReservedRange reserved_range = 4;
$this
setReservedRange(EnumReservedRange[] $var)
Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap.
Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto.EnumReservedRange reserved_range = 4;
RepeatedField<string>
getReservedName()
Reserved enum value names, which may not be reused. A given name may only be reserved once.
Generated from protobuf field repeated string reserved_name = 5;
$this
setReservedName(string[] $var)
Reserved enum value names, which may not be reused. A given name may only be reserved once.
Generated from protobuf field repeated string reserved_name = 5;
int
getVisibility()
Support for export and local keywords on enums.
Generated from protobuf field optional .google.protobuf.SymbolVisibility visibility = 6;
hasVisibility()
No description
clearVisibility()
No description
$this
setVisibility(int $var)
Support for export and local keywords on enums.
Generated from protobuf field optional .google.protobuf.SymbolVisibility visibility = 6;