Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. FileDescriptorProto.php

class FileDescriptorProto

Describes a complete .proto file.

Generated from protobuf message <code>google.protobuf.FileDescriptorProto</code>

Hierarchy

  • class \Google\Protobuf\Internal\Message
    • class \Google\Protobuf\Internal\FileDescriptorProto extends \Google\Protobuf\Internal\Message

Expanded class hierarchy of FileDescriptorProto

File

vendor/google/protobuf/src/Google/Protobuf/Internal/FileDescriptorProto.php, line 18

Namespace

Google\Protobuf\Internal
View source
class FileDescriptorProto extends \Google\Protobuf\Internal\Message {
    
    /**
     * file name, relative to root of source tree
     *
     * Generated from protobuf field <code>optional string name = 1;</code>
     */
    protected $name = null;
    
    /**
     * e.g. "foo", "foo.bar", etc.
     *
     * Generated from protobuf field <code>optional string package = 2;</code>
     */
    protected $package = null;
    
    /**
     * Names of files imported by this file.
     *
     * Generated from protobuf field <code>repeated string dependency = 3;</code>
     */
    private $dependency;
    
    /**
     * Indexes of the public imported files in the dependency list above.
     *
     * Generated from protobuf field <code>repeated int32 public_dependency = 10;</code>
     */
    private $public_dependency;
    
    /**
     * Indexes of the weak imported files in the dependency list.
     * For Google-internal migration only. Do not use.
     *
     * Generated from protobuf field <code>repeated int32 weak_dependency = 11;</code>
     */
    private $weak_dependency;
    
    /**
     * All top-level definitions in this file.
     *
     * Generated from protobuf field <code>repeated .google.protobuf.DescriptorProto message_type = 4;</code>
     */
    private $message_type;
    
    /**
     * Generated from protobuf field <code>repeated .google.protobuf.EnumDescriptorProto enum_type = 5;</code>
     */
    private $enum_type;
    
    /**
     * Generated from protobuf field <code>repeated .google.protobuf.ServiceDescriptorProto service = 6;</code>
     */
    private $service;
    
    /**
     * Generated from protobuf field <code>repeated .google.protobuf.FieldDescriptorProto extension = 7;</code>
     */
    private $extension;
    
    /**
     * Generated from protobuf field <code>optional .google.protobuf.FileOptions options = 8;</code>
     */
    protected $options = null;
    
    /**
     * 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 <code>optional .google.protobuf.SourceCodeInfo source_code_info = 9;</code>
     */
    protected $source_code_info = null;
    
    /**
     * The syntax of the proto file.
     * The supported values are "proto2", "proto3", and "editions".
     * If `edition` is present, this value must be "editions".
     *
     * Generated from protobuf field <code>optional string syntax = 12;</code>
     */
    protected $syntax = null;
    
    /**
     * The edition of the proto file, which is an opaque string.
     *
     * Generated from protobuf field <code>optional string edition = 13;</code>
     */
    protected $edition = null;
    
    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $name
     *           file name, relative to root of source tree
     *     @type string $package
     *           e.g. "foo", "foo.bar", etc.
     *     @type array<string>|\Google\Protobuf\Internal\RepeatedField $dependency
     *           Names of files imported by this file.
     *     @type array<int>|\Google\Protobuf\Internal\RepeatedField $public_dependency
     *           Indexes of the public imported files in the dependency list above.
     *     @type array<int>|\Google\Protobuf\Internal\RepeatedField $weak_dependency
     *           Indexes of the weak imported files in the dependency list.
     *           For Google-internal migration only. Do not use.
     *     @type array<\Google\Protobuf\Internal\DescriptorProto>|\Google\Protobuf\Internal\RepeatedField $message_type
     *           All top-level definitions in this file.
     *     @type array<\Google\Protobuf\Internal\EnumDescriptorProto>|\Google\Protobuf\Internal\RepeatedField $enum_type
     *     @type array<\Google\Protobuf\Internal\ServiceDescriptorProto>|\Google\Protobuf\Internal\RepeatedField $service
     *     @type array<\Google\Protobuf\Internal\FieldDescriptorProto>|\Google\Protobuf\Internal\RepeatedField $extension
     *     @type \Google\Protobuf\Internal\FileOptions $options
     *     @type \Google\Protobuf\Internal\SourceCodeInfo $source_code_info
     *           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.
     *     @type string $syntax
     *           The syntax of the proto file.
     *           The supported values are "proto2", "proto3", and "editions".
     *           If `edition` is present, this value must be "editions".
     *     @type string $edition
     *           The edition of the proto file, which is an opaque string.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Protobuf\Internal\Descriptor::initOnce();
        parent::__construct($data);
    }
    
    /**
     * file name, relative to root of source tree
     *
     * Generated from protobuf field <code>optional string name = 1;</code>
     * @return string
     */
    public function getName() {
        return isset($this->name) ? $this->name : '';
    }
    public function hasName() {
        return isset($this->name);
    }
    public function clearName() {
        unset($this->name);
    }
    
    /**
     * file name, relative to root of source tree
     *
     * Generated from protobuf field <code>optional string name = 1;</code>
     * @param string $var
     * @return $this
     */
    public function setName($var) {
        GPBUtil::checkString($var, True);
        $this->name = $var;
        return $this;
    }
    
    /**
     * e.g. "foo", "foo.bar", etc.
     *
     * Generated from protobuf field <code>optional string package = 2;</code>
     * @return string
     */
    public function getPackage() {
        return isset($this->package) ? $this->package : '';
    }
    public function hasPackage() {
        return isset($this->package);
    }
    public function clearPackage() {
        unset($this->package);
    }
    
    /**
     * e.g. "foo", "foo.bar", etc.
     *
     * Generated from protobuf field <code>optional string package = 2;</code>
     * @param string $var
     * @return $this
     */
    public function setPackage($var) {
        GPBUtil::checkString($var, True);
        $this->package = $var;
        return $this;
    }
    
    /**
     * Names of files imported by this file.
     *
     * Generated from protobuf field <code>repeated string dependency = 3;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getDependency() {
        return $this->dependency;
    }
    
    /**
     * Names of files imported by this file.
     *
     * Generated from protobuf field <code>repeated string dependency = 3;</code>
     * @param array<string>|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setDependency($var) {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
        $this->dependency = $arr;
        return $this;
    }
    
    /**
     * Indexes of the public imported files in the dependency list above.
     *
     * Generated from protobuf field <code>repeated int32 public_dependency = 10;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getPublicDependency() {
        return $this->public_dependency;
    }
    
    /**
     * Indexes of the public imported files in the dependency list above.
     *
     * Generated from protobuf field <code>repeated int32 public_dependency = 10;</code>
     * @param array<int>|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setPublicDependency($var) {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT32);
        $this->public_dependency = $arr;
        return $this;
    }
    
    /**
     * Indexes of the weak imported files in the dependency list.
     * For Google-internal migration only. Do not use.
     *
     * Generated from protobuf field <code>repeated int32 weak_dependency = 11;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getWeakDependency() {
        return $this->weak_dependency;
    }
    
    /**
     * Indexes of the weak imported files in the dependency list.
     * For Google-internal migration only. Do not use.
     *
     * Generated from protobuf field <code>repeated int32 weak_dependency = 11;</code>
     * @param array<int>|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setWeakDependency($var) {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT32);
        $this->weak_dependency = $arr;
        return $this;
    }
    
    /**
     * All top-level definitions in this file.
     *
     * Generated from protobuf field <code>repeated .google.protobuf.DescriptorProto message_type = 4;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getMessageType() {
        return $this->message_type;
    }
    
    /**
     * All top-level definitions in this file.
     *
     * Generated from protobuf field <code>repeated .google.protobuf.DescriptorProto message_type = 4;</code>
     * @param array<\Google\Protobuf\Internal\DescriptorProto>|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setMessageType($var) {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Protobuf\Internal\DescriptorProto::class);
        $this->message_type = $arr;
        return $this;
    }
    
    /**
     * Generated from protobuf field <code>repeated .google.protobuf.EnumDescriptorProto enum_type = 5;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getEnumType() {
        return $this->enum_type;
    }
    
    /**
     * Generated from protobuf field <code>repeated .google.protobuf.EnumDescriptorProto enum_type = 5;</code>
     * @param array<\Google\Protobuf\Internal\EnumDescriptorProto>|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setEnumType($var) {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Protobuf\Internal\EnumDescriptorProto::class);
        $this->enum_type = $arr;
        return $this;
    }
    
    /**
     * Generated from protobuf field <code>repeated .google.protobuf.ServiceDescriptorProto service = 6;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getService() {
        return $this->service;
    }
    
    /**
     * Generated from protobuf field <code>repeated .google.protobuf.ServiceDescriptorProto service = 6;</code>
     * @param array<\Google\Protobuf\Internal\ServiceDescriptorProto>|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setService($var) {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Protobuf\Internal\ServiceDescriptorProto::class);
        $this->service = $arr;
        return $this;
    }
    
    /**
     * Generated from protobuf field <code>repeated .google.protobuf.FieldDescriptorProto extension = 7;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getExtension() {
        return $this->extension;
    }
    
    /**
     * Generated from protobuf field <code>repeated .google.protobuf.FieldDescriptorProto extension = 7;</code>
     * @param array<\Google\Protobuf\Internal\FieldDescriptorProto>|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setExtension($var) {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Protobuf\Internal\FieldDescriptorProto::class);
        $this->extension = $arr;
        return $this;
    }
    
    /**
     * Generated from protobuf field <code>optional .google.protobuf.FileOptions options = 8;</code>
     * @return \Google\Protobuf\Internal\FileOptions|null
     */
    public function getOptions() {
        return $this->options;
    }
    public function hasOptions() {
        return isset($this->options);
    }
    public function clearOptions() {
        unset($this->options);
    }
    
    /**
     * Generated from protobuf field <code>optional .google.protobuf.FileOptions options = 8;</code>
     * @param \Google\Protobuf\Internal\FileOptions $var
     * @return $this
     */
    public function setOptions($var) {
        GPBUtil::checkMessage($var, \Google\Protobuf\Internal\FileOptions::class);
        $this->options = $var;
        return $this;
    }
    
    /**
     * 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 <code>optional .google.protobuf.SourceCodeInfo source_code_info = 9;</code>
     * @return \Google\Protobuf\Internal\SourceCodeInfo|null
     */
    public function getSourceCodeInfo() {
        return $this->source_code_info;
    }
    public function hasSourceCodeInfo() {
        return isset($this->source_code_info);
    }
    public function clearSourceCodeInfo() {
        unset($this->source_code_info);
    }
    
    /**
     * 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 <code>optional .google.protobuf.SourceCodeInfo source_code_info = 9;</code>
     * @param \Google\Protobuf\Internal\SourceCodeInfo $var
     * @return $this
     */
    public function setSourceCodeInfo($var) {
        GPBUtil::checkMessage($var, \Google\Protobuf\Internal\SourceCodeInfo::class);
        $this->source_code_info = $var;
        return $this;
    }
    
    /**
     * The syntax of the proto file.
     * The supported values are "proto2", "proto3", and "editions".
     * If `edition` is present, this value must be "editions".
     *
     * Generated from protobuf field <code>optional string syntax = 12;</code>
     * @return string
     */
    public function getSyntax() {
        return isset($this->syntax) ? $this->syntax : '';
    }
    public function hasSyntax() {
        return isset($this->syntax);
    }
    public function clearSyntax() {
        unset($this->syntax);
    }
    
    /**
     * The syntax of the proto file.
     * The supported values are "proto2", "proto3", and "editions".
     * If `edition` is present, this value must be "editions".
     *
     * Generated from protobuf field <code>optional string syntax = 12;</code>
     * @param string $var
     * @return $this
     */
    public function setSyntax($var) {
        GPBUtil::checkString($var, True);
        $this->syntax = $var;
        return $this;
    }
    
    /**
     * The edition of the proto file, which is an opaque string.
     *
     * Generated from protobuf field <code>optional string edition = 13;</code>
     * @return string
     */
    public function getEdition() {
        return isset($this->edition) ? $this->edition : '';
    }
    public function hasEdition() {
        return isset($this->edition);
    }
    public function clearEdition() {
        unset($this->edition);
    }
    
    /**
     * The edition of the proto file, which is an opaque string.
     *
     * Generated from protobuf field <code>optional string edition = 13;</code>
     * @param string $var
     * @return $this
     */
    public function setEdition($var) {
        GPBUtil::checkString($var, True);
        $this->edition = $var;
        return $this;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
FileDescriptorProto::$dependency private property Names of files imported by this file.
FileDescriptorProto::$edition protected property The edition of the proto file, which is an opaque string.
FileDescriptorProto::$enum_type private property Generated from protobuf field &lt;code&gt;repeated .google.protobuf.EnumDescriptorProto enum_type = 5;&lt;/code&gt;
FileDescriptorProto::$extension private property Generated from protobuf field &lt;code&gt;repeated .google.protobuf.FieldDescriptorProto extension = 7;&lt;/code&gt;
FileDescriptorProto::$message_type private property All top-level definitions in this file.
FileDescriptorProto::$name protected property file name, relative to root of source tree
FileDescriptorProto::$options protected property Generated from protobuf field &lt;code&gt;optional .google.protobuf.FileOptions options = 8;&lt;/code&gt;
FileDescriptorProto::$package protected property e.g. &quot;foo&quot;, &quot;foo.bar&quot;, etc.
FileDescriptorProto::$public_dependency private property Indexes of the public imported files in the dependency list above.
FileDescriptorProto::$service private property Generated from protobuf field &lt;code&gt;repeated .google.protobuf.ServiceDescriptorProto service = 6;&lt;/code&gt;
FileDescriptorProto::$source_code_info protected property 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.
FileDescriptorProto::$syntax protected property The syntax of the proto file.
The supported values are &quot;proto2&quot;, &quot;proto3&quot;, and &quot;editions&quot;.
If `edition` is present, this value must be &quot;editions&quot;.
FileDescriptorProto::$weak_dependency private property Indexes of the weak imported files in the dependency list.
For Google-internal migration only. Do not use.
FileDescriptorProto::clearEdition public function
FileDescriptorProto::clearName public function
FileDescriptorProto::clearOptions public function
FileDescriptorProto::clearPackage public function
FileDescriptorProto::clearSourceCodeInfo public function
FileDescriptorProto::clearSyntax public function
FileDescriptorProto::getDependency public function Names of files imported by this file.
FileDescriptorProto::getEdition public function The edition of the proto file, which is an opaque string.
FileDescriptorProto::getEnumType public function Generated from protobuf field &lt;code&gt;repeated .google.protobuf.EnumDescriptorProto enum_type = 5;&lt;/code&gt;
FileDescriptorProto::getExtension public function Generated from protobuf field &lt;code&gt;repeated .google.protobuf.FieldDescriptorProto extension = 7;&lt;/code&gt;
FileDescriptorProto::getMessageType public function All top-level definitions in this file.
FileDescriptorProto::getName public function file name, relative to root of source tree
FileDescriptorProto::getOptions public function Generated from protobuf field &lt;code&gt;optional .google.protobuf.FileOptions options = 8;&lt;/code&gt;
FileDescriptorProto::getPackage public function e.g. &quot;foo&quot;, &quot;foo.bar&quot;, etc.
FileDescriptorProto::getPublicDependency public function Indexes of the public imported files in the dependency list above.
FileDescriptorProto::getService public function Generated from protobuf field &lt;code&gt;repeated .google.protobuf.ServiceDescriptorProto service = 6;&lt;/code&gt;
FileDescriptorProto::getSourceCodeInfo public function 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.
FileDescriptorProto::getSyntax public function The syntax of the proto file.
The supported values are &quot;proto2&quot;, &quot;proto3&quot;, and &quot;editions&quot;.
If `edition` is present, this value must be &quot;editions&quot;.
FileDescriptorProto::getWeakDependency public function Indexes of the weak imported files in the dependency list.
For Google-internal migration only. Do not use.
FileDescriptorProto::hasEdition public function
FileDescriptorProto::hasName public function
FileDescriptorProto::hasOptions public function
FileDescriptorProto::hasPackage public function
FileDescriptorProto::hasSourceCodeInfo public function
FileDescriptorProto::hasSyntax public function
FileDescriptorProto::setDependency public function Names of files imported by this file.
FileDescriptorProto::setEdition public function The edition of the proto file, which is an opaque string.
FileDescriptorProto::setEnumType public function Generated from protobuf field &lt;code&gt;repeated .google.protobuf.EnumDescriptorProto enum_type = 5;&lt;/code&gt;
FileDescriptorProto::setExtension public function Generated from protobuf field &lt;code&gt;repeated .google.protobuf.FieldDescriptorProto extension = 7;&lt;/code&gt;
FileDescriptorProto::setMessageType public function All top-level definitions in this file.
FileDescriptorProto::setName public function file name, relative to root of source tree
FileDescriptorProto::setOptions public function Generated from protobuf field &lt;code&gt;optional .google.protobuf.FileOptions options = 8;&lt;/code&gt;
FileDescriptorProto::setPackage public function e.g. &quot;foo&quot;, &quot;foo.bar&quot;, etc.
FileDescriptorProto::setPublicDependency public function Indexes of the public imported files in the dependency list above.
FileDescriptorProto::setService public function Generated from protobuf field &lt;code&gt;repeated .google.protobuf.ServiceDescriptorProto service = 6;&lt;/code&gt;
FileDescriptorProto::setSourceCodeInfo public function 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.
FileDescriptorProto::setSyntax public function The syntax of the proto file.
The supported values are &quot;proto2&quot;, &quot;proto3&quot;, and &quot;editions&quot;.
If `edition` is present, this value must be &quot;editions&quot;.
FileDescriptorProto::setWeakDependency public function Indexes of the weak imported files in the dependency list.
For Google-internal migration only. Do not use.
FileDescriptorProto::__construct public function Constructor. Overrides Message::__construct
Message::$desc private property @ignore
Message::$unknown private property
Message::appendHelper private function
Message::byteSize public function @ignore
Message::clear public function Clear all containing fields.
Message::convertJsonValueToProtoValue private function
Message::defaultValue private function @ignore
Message::discardUnknownFields public function Clear all unknown fields previously parsed.
Message::existField private function @ignore
Message::fieldByteSize private function @ignore
Message::fieldDataOnlyByteSize private function @ignore
Message::fieldDataOnlyJsonByteSize private function @ignore
Message::fieldJsonByteSize private function @ignore
Message::hasOneof protected function
Message::initWithDescriptor private function @ignore
Message::initWithGeneratedPool private function @ignore
Message::jsonByteSize public function @ignore
Message::kvUpdateHelper private function
Message::mergeFrom public function Merges the contents of the specified message into current message.
Message::mergeFromArray protected function Populates the message from a user-supplied PHP array. Array keys
correspond to Message properties and nested message properties.
Message::mergeFromArrayJsonImpl private function
Message::mergeFromJsonArray protected function
Message::mergeFromJsonString public function Parses a json string to protobuf message.
Message::mergeFromString public function Parses a protocol buffer contained in a string.
Message::normalizeArrayElementsToMessageType private static function Tries to normalize the elements in $value into a provided protobuf
wrapper type $class. If $value is any type other than array, we do
not do any conversion, and instead rely on the existing protobuf
type checking. If $value is an array, we process…
Message::normalizeToMessageType private static function Tries to normalize $value into a provided protobuf wrapper type $class.
If $value is any type other than an object, we attempt to construct an
instance of $class and assign $value to it using the setValue method
shared by all wrapper types.
Message::parseFieldFromStream private function @ignore
Message::parseFieldFromStreamNoTag private static function @ignore
Message::parseFromJsonStream public function @ignore
Message::parseFromStream public function @ignore
Message::readOneof protected function
Message::readWrapperValue protected function
Message::repeatedFieldDataOnlyByteSize private function @ignore
Message::serializeFieldToJsonStream private function @ignore
Message::serializeFieldToStream private function @ignore
Message::serializeMapFieldToStream private function @ignore
Message::serializeRepeatedFieldToStream private function @ignore
Message::serializeSingularFieldToStream private function @ignore
Message::serializeToJsonStream public function @ignore
Message::serializeToJsonString public function Serialize the message to json string.
Message::serializeToStream public function @ignore
Message::serializeToString public function Serialize the message to string.
Message::skipField private function @ignore
Message::whichOneof protected function
Message::writeOneof protected function
Message::writeWrapperValue protected function
Message::__debugInfo public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal