FileDescriptorProto
class FileDescriptorProto extends Message (View source)
Describes a complete .proto file.
Generated from protobuf message google.protobuf.FileDescriptorProto
Properties
| protected | $name | file name, relative to root of source tree |
|
| protected | $package | e.g. "foo", "foo.bar", etc. |
|
| protected | $options | Generated from protobuf field |
|
| protected | $source_code_info | This field contains optional information about the original source code. |
|
| protected | $syntax | The syntax of the proto file. |
|
| protected | $edition | The edition of the proto file. |
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.
file name, relative to root of source tree
No description
No description
file name, relative to root of source tree
e.g. "foo", "foo.bar", etc.
No description
No description
e.g. "foo", "foo.bar", etc.
Names of files imported by this file.
Names of files imported by this file.
Indexes of the public imported files in the dependency list above.
Indexes of the public imported files in the dependency list above.
Indexes of the weak imported files in the dependency list.
Indexes of the weak imported files in the dependency list.
Names of files imported by this file purely for the purpose of providing option extensions. These are excluded from the dependency list above.
Names of files imported by this file purely for the purpose of providing option extensions. These are excluded from the dependency list above.
All top-level definitions in this file.
Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 5;
Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 5;
Generated from protobuf field repeated .google.protobuf.ServiceDescriptorProto service = 6;
Generated from protobuf field repeated .google.protobuf.ServiceDescriptorProto service = 6;
Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 7;
Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 7;
Generated from protobuf field optional .google.protobuf.FileOptions options = 8;
No description
No description
Generated from protobuf field optional .google.protobuf.FileOptions options = 8;
This field contains optional information about the original source code.
No description
No description
This field contains optional information about the original source code.
The syntax of the proto file.
No description
No description
The syntax of the proto file.
The edition of the proto file.
No description
No description
The edition of the proto file.
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()
file name, relative to root of source tree
Generated from protobuf field optional string name = 1;
hasName()
No description
clearName()
No description
$this
setName(string $var)
file name, relative to root of source tree
Generated from protobuf field optional string name = 1;
string
getPackage()
e.g. "foo", "foo.bar", etc.
Generated from protobuf field optional string package = 2;
hasPackage()
No description
clearPackage()
No description
$this
setPackage(string $var)
e.g. "foo", "foo.bar", etc.
Generated from protobuf field optional string package = 2;
RepeatedField<string>
getDependency()
Names of files imported by this file.
Generated from protobuf field repeated string dependency = 3;
$this
setDependency(string[] $var)
Names of files imported by this file.
Generated from protobuf field repeated string dependency = 3;
RepeatedField<int>
getPublicDependency()
Indexes of the public imported files in the dependency list above.
Generated from protobuf field repeated int32 public_dependency = 10;
$this
setPublicDependency(int[] $var)
Indexes of the public imported files in the dependency list above.
Generated from protobuf field repeated int32 public_dependency = 10;
RepeatedField<int>
getWeakDependency()
Indexes of the weak imported files in the dependency list.
For Google-internal migration only. Do not use.
Generated from protobuf field repeated int32 weak_dependency = 11;
$this
setWeakDependency(int[] $var)
Indexes of the weak imported files in the dependency list.
For Google-internal migration only. Do not use.
Generated from protobuf field repeated int32 weak_dependency = 11;
RepeatedField<string>
getOptionDependency()
Names of files imported by this file purely for the purpose of providing option extensions. These are excluded from the dependency list above.
Generated from protobuf field repeated string option_dependency = 15;
$this
setOptionDependency(string[] $var)
Names of files imported by this file purely for the purpose of providing option extensions. These are excluded from the dependency list above.
Generated from protobuf field repeated string option_dependency = 15;
DescriptorProto>
getMessageType()
All top-level definitions in this file.
Generated from protobuf field repeated .google.protobuf.DescriptorProto message_type = 4;
$this
setMessageType(DescriptorProto[] $var)
All top-level definitions in this file.
Generated from protobuf field repeated .google.protobuf.DescriptorProto message_type = 4;
EnumDescriptorProto>
getEnumType()
Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 5;
$this
setEnumType(EnumDescriptorProto[] $var)
Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 5;
ServiceDescriptorProto>
getService()
Generated from protobuf field repeated .google.protobuf.ServiceDescriptorProto service = 6;
$this
setService(ServiceDescriptorProto[] $var)
Generated from protobuf field repeated .google.protobuf.ServiceDescriptorProto service = 6;
FieldDescriptorProto>
getExtension()
Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 7;
$this
setExtension(FieldDescriptorProto[] $var)
Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 7;
FileOptions|null
getOptions()
Generated from protobuf field optional .google.protobuf.FileOptions options = 8;
hasOptions()
No description
clearOptions()
No description
$this
setOptions(FileOptions $var)
Generated from protobuf field optional .google.protobuf.FileOptions options = 8;
SourceCodeInfo|null
getSourceCodeInfo()
This field contains optional information about the original source code.
You may safely remove this entire field without harming runtime functionality of the descriptors -- the information is needed only by development tools.
Generated from protobuf field optional .google.protobuf.SourceCodeInfo source_code_info = 9;
hasSourceCodeInfo()
No description
clearSourceCodeInfo()
No description
$this
setSourceCodeInfo(SourceCodeInfo $var)
This field contains optional information about the original source code.
You may safely remove this entire field without harming runtime functionality of the descriptors -- the information is needed only by development tools.
Generated from protobuf field optional .google.protobuf.SourceCodeInfo source_code_info = 9;
string
getSyntax()
The syntax of the proto file.
The supported values are "proto2", "proto3", and "editions".
If edition is present, this value must be "editions".
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 string syntax = 12;
hasSyntax()
No description
clearSyntax()
No description
$this
setSyntax(string $var)
The syntax of the proto file.
The supported values are "proto2", "proto3", and "editions".
If edition is present, this value must be "editions".
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 string syntax = 12;
int
getEdition()
The edition of the proto file.
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.Edition edition = 14;
hasEdition()
No description
clearEdition()
No description
$this
setEdition(int $var)
The edition of the proto file.
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.Edition edition = 14;