Type
class Type extends Message (View source)
A protocol buffer message type.
New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.
Generated from protobuf message google.protobuf.Type
Properties
| protected | $name | The fully qualified message name. |
|
| protected | $source_context | The source context. |
|
| protected | $syntax | The source syntax. |
|
| protected | $edition | The source edition string, only valid when syntax is SYNTAX_EDITIONS. |
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.
The fully qualified message name.
The fully qualified message name.
The list of fields.
The list of types appearing in oneof definitions in this type.
The list of types appearing in oneof definitions in this type.
The protocol buffer options.
The source context.
No description
No description
The source syntax.
The source syntax.
The source edition string, only valid when syntax is SYNTAX_EDITIONS.
The source edition string, only valid when syntax is SYNTAX_EDITIONS.
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()
The fully qualified message name.
Generated from protobuf field string name = 1;
$this
setName(string $var)
The fully qualified message name.
Generated from protobuf field string name = 1;
Field>
getFields()
The list of fields.
Generated from protobuf field repeated .google.protobuf.Field fields = 2;
$this
setFields(Field[] $var)
The list of fields.
Generated from protobuf field repeated .google.protobuf.Field fields = 2;
RepeatedField<string>
getOneofs()
The list of types appearing in oneof definitions in this type.
Generated from protobuf field repeated string oneofs = 3;
$this
setOneofs(string[] $var)
The list of types appearing in oneof definitions in this type.
Generated from protobuf field repeated string oneofs = 3;
Option>
getOptions()
The protocol buffer options.
Generated from protobuf field repeated .google.protobuf.Option options = 4;
$this
setOptions(Option[] $var)
The protocol buffer options.
Generated from protobuf field repeated .google.protobuf.Option options = 4;
SourceContext|null
getSourceContext()
The source context.
Generated from protobuf field .google.protobuf.SourceContext source_context = 5;
hasSourceContext()
No description
clearSourceContext()
No description
$this
setSourceContext(SourceContext $var)
The source context.
Generated from protobuf field .google.protobuf.SourceContext source_context = 5;
int
getSyntax()
The source syntax.
Generated from protobuf field .google.protobuf.Syntax syntax = 6;
$this
setSyntax(int $var)
The source syntax.
Generated from protobuf field .google.protobuf.Syntax syntax = 6;
string
getEdition()
The source edition string, only valid when syntax is SYNTAX_EDITIONS.
Generated from protobuf field string edition = 7;
$this
setEdition(string $var)
The source edition string, only valid when syntax is SYNTAX_EDITIONS.
Generated from protobuf field string edition = 7;