FieldDescriptorProto
class FieldDescriptorProto extends Message (View source)
Describes a field within a message.
Generated from protobuf message google.protobuf.FieldDescriptorProto
Properties
| protected | $name | Generated from protobuf field |
|
| protected | $number | Generated from protobuf field |
|
| protected | $label | Generated from protobuf field |
|
| protected | $type | If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP. |
|
| protected | $type_name | For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace). |
|
| protected | $extendee | For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name. |
|
| protected | $default_value | For numeric types, contains the original text representation of the value. |
|
| protected | $oneof_index | If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof. |
|
| protected | $json_name | JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase. |
|
| protected | $options | Generated from protobuf field |
|
| protected | $proto3_optional | If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. |
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 optional int32 number = 3;
No description
No description
Generated from protobuf field optional int32 number = 3;
Generated from protobuf field optional .google.protobuf.FieldDescriptorProto.Label label = 4;
No description
No description
Generated from protobuf field optional .google.protobuf.FieldDescriptorProto.Label label = 4;
If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
No description
No description
If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
No description
No description
For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
No description
No description
For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
For numeric types, contains the original text representation of the value.
No description
No description
For numeric types, contains the original text representation of the value.
If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
No description
No description
If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
No description
No description
JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
Generated from protobuf field optional .google.protobuf.FieldOptions options = 8;
No description
No description
Generated from protobuf field optional .google.protobuf.FieldOptions options = 8;
If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type.
No description
No description
If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type.
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;
int
getNumber()
Generated from protobuf field optional int32 number = 3;
hasNumber()
No description
clearNumber()
No description
$this
setNumber(int $var)
Generated from protobuf field optional int32 number = 3;
int
getLabel()
Generated from protobuf field optional .google.protobuf.FieldDescriptorProto.Label label = 4;
hasLabel()
No description
clearLabel()
No description
$this
setLabel(int $var)
Generated from protobuf field optional .google.protobuf.FieldDescriptorProto.Label label = 4;
int
getType()
If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
Generated from protobuf field optional .google.protobuf.FieldDescriptorProto.Type type = 5;
hasType()
No description
clearType()
No description
$this
setType(int $var)
If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
Generated from protobuf field optional .google.protobuf.FieldDescriptorProto.Type type = 5;
string
getTypeName()
For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
Generated from protobuf field optional string type_name = 6;
hasTypeName()
No description
clearTypeName()
No description
$this
setTypeName(string $var)
For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
Generated from protobuf field optional string type_name = 6;
string
getExtendee()
For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
Generated from protobuf field optional string extendee = 2;
hasExtendee()
No description
clearExtendee()
No description
$this
setExtendee(string $var)
For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
Generated from protobuf field optional string extendee = 2;
string
getDefaultValue()
For numeric types, contains the original text representation of the value.
For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped.
Generated from protobuf field optional string default_value = 7;
hasDefaultValue()
No description
clearDefaultValue()
No description
$this
setDefaultValue(string $var)
For numeric types, contains the original text representation of the value.
For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped.
Generated from protobuf field optional string default_value = 7;
int
getOneofIndex()
If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
Generated from protobuf field optional int32 oneof_index = 9;
hasOneofIndex()
No description
clearOneofIndex()
No description
$this
setOneofIndex(int $var)
If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
Generated from protobuf field optional int32 oneof_index = 9;
string
getJsonName()
JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
Generated from protobuf field optional string json_name = 10;
hasJsonName()
No description
clearJsonName()
No description
$this
setJsonName(string $var)
JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
Generated from protobuf field optional string json_name = 10;
FieldOptions|null
getOptions()
Generated from protobuf field optional .google.protobuf.FieldOptions options = 8;
hasOptions()
No description
clearOptions()
No description
$this
setOptions(FieldOptions $var)
Generated from protobuf field optional .google.protobuf.FieldOptions options = 8;
bool
getProto3Optional()
If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type.
When proto3_optional is true, this field must be belong to a oneof to
signal to old proto3 clients that presence is tracked for this field. This
oneof is known as a "synthetic" oneof, and this field must be its sole
member (each proto3 optional field gets its own synthetic oneof). Synthetic
oneofs exist in the descriptor only, and do not generate any API. Synthetic
oneofs must be ordered after all "real" oneofs.
For message fields, proto3_optional doesn't create any semantic change,
since non-repeated message fields always track presence. However it still
indicates the semantic detail of whether the user wrote "optional" or not.
This can be useful for round-tripping the .proto file. For consistency we
give message fields a synthetic oneof also, even though it is not required
to track presence. This is especially important because the parser can't
tell if a field is a message or an enum, so it must always create a
synthetic oneof.
Proto2 optional fields do not set this flag, because they already indicate
optional with LABEL_OPTIONAL.
Generated from protobuf field optional bool proto3_optional = 17;
hasProto3Optional()
No description
clearProto3Optional()
No description
$this
setProto3Optional(bool $var)
If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type.
When proto3_optional is true, this field must be belong to a oneof to
signal to old proto3 clients that presence is tracked for this field. This
oneof is known as a "synthetic" oneof, and this field must be its sole
member (each proto3 optional field gets its own synthetic oneof). Synthetic
oneofs exist in the descriptor only, and do not generate any API. Synthetic
oneofs must be ordered after all "real" oneofs.
For message fields, proto3_optional doesn't create any semantic change,
since non-repeated message fields always track presence. However it still
indicates the semantic detail of whether the user wrote "optional" or not.
This can be useful for round-tripping the .proto file. For consistency we
give message fields a synthetic oneof also, even though it is not required
to track presence. This is especially important because the parser can't
tell if a field is a message or an enum, so it must always create a
synthetic oneof.
Proto2 optional fields do not set this flag, because they already indicate
optional with LABEL_OPTIONAL.
Generated from protobuf field optional bool proto3_optional = 17;