DescriptorProto
class DescriptorProto extends Message (View source)
Describes a message type.
Generated from protobuf message google.protobuf.DescriptorProto
Properties
| protected | $name | Generated from protobuf field |
|
| protected | $options | Generated from protobuf field |
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.FieldDescriptorProto field = 2;
Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto field = 2;
Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 6;
Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 6;
Generated from protobuf field repeated .google.protobuf.DescriptorProto nested_type = 3;
Generated from protobuf field repeated .google.protobuf.DescriptorProto nested_type = 3;
Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 4;
Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 4;
Generated from protobuf field repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;
Generated from protobuf field repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;
Generated from protobuf field repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;
Generated from protobuf field repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;
Generated from protobuf field optional .google.protobuf.MessageOptions options = 7;
No description
No description
Generated from protobuf field optional .google.protobuf.MessageOptions options = 7;
Generated from protobuf field repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;
Generated from protobuf field repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;
Reserved field names, which may not be used by fields in the same message.
Reserved field names, which may not be used by fields in the same message.
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
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.
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.
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.
parseFromStream($input)
No description
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.
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()
Serialize the message to json string.
byteSize()
No description
jsonByteSize()
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;
RepeatedField
getField()
Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto field = 2;
$this
setField(FieldDescriptorProto[]|RepeatedField $var)
Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto field = 2;
RepeatedField
getExtension()
Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 6;
$this
setExtension(FieldDescriptorProto[]|RepeatedField $var)
Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 6;
RepeatedField
getNestedType()
Generated from protobuf field repeated .google.protobuf.DescriptorProto nested_type = 3;
$this
setNestedType(DescriptorProto[]|RepeatedField $var)
Generated from protobuf field repeated .google.protobuf.DescriptorProto nested_type = 3;
RepeatedField
getEnumType()
Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 4;
$this
setEnumType(EnumDescriptorProto[]|RepeatedField $var)
Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 4;
RepeatedField
getExtensionRange()
Generated from protobuf field repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;
$this
setExtensionRange(ExtensionRange[]|RepeatedField $var)
Generated from protobuf field repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;
RepeatedField
getOneofDecl()
Generated from protobuf field repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;
$this
setOneofDecl(OneofDescriptorProto[]|RepeatedField $var)
Generated from protobuf field repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;
MessageOptions|null
getOptions()
Generated from protobuf field optional .google.protobuf.MessageOptions options = 7;
hasOptions()
No description
clearOptions()
No description
$this
setOptions(MessageOptions $var)
Generated from protobuf field optional .google.protobuf.MessageOptions options = 7;
RepeatedField
getReservedRange()
Generated from protobuf field repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;
$this
setReservedRange(ReservedRange[]|RepeatedField $var)
Generated from protobuf field repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;
RepeatedField
getReservedName()
Reserved field names, which may not be used by fields in the same message.
A given name may only be reserved once.
Generated from protobuf field repeated string reserved_name = 10;
$this
setReservedName(string[]|RepeatedField $var)
Reserved field names, which may not be used by fields in the same message.
A given name may only be reserved once.
Generated from protobuf field repeated string reserved_name = 10;