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

Breadcrumb

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

class FieldDescriptor

Same name in this branch
  1. 11.1.x vendor/google/protobuf/src/Google/Protobuf/Internal/FieldDescriptor.php \Google\Protobuf\Internal\FieldDescriptor

Hierarchy

  • class \Google\Protobuf\FieldDescriptor uses \Google\Protobuf\Internal\GetPublicDescriptorTrait

Expanded class hierarchy of FieldDescriptor

1 file declares its use of FieldDescriptor
ProtobufSerializer.php in vendor/open-telemetry/exporter-otlp/ProtobufSerializer.php

File

vendor/google/protobuf/src/Google/Protobuf/FieldDescriptor.php, line 15

Namespace

Google\Protobuf
View source
class FieldDescriptor {
    use GetPublicDescriptorTrait;
    
    /** @var  \Google\Protobuf\Internal\FieldDescriptor $internal_desc */
    private $internal_desc;
    
    /**
     * @internal
     */
    public function __construct($internal_desc) {
        $this->internal_desc = $internal_desc;
    }
    
    /**
     * @return string Field name
     */
    public function getName() {
        return $this->internal_desc
            ->getName();
    }
    
    /**
     * @return int Protobuf field number
     */
    public function getNumber() {
        return $this->internal_desc
            ->getNumber();
    }
    
    /**
     * @return int
     */
    public function getLabel() {
        return $this->internal_desc
            ->getLabel();
    }
    
    /**
     * @return int
     */
    public function getType() {
        return $this->internal_desc
            ->getType();
    }
    
    /**
     * @return OneofDescriptor
     */
    public function getContainingOneof() {
        return $this->getPublicDescriptor($this->internal_desc
            ->getContainingOneof());
    }
    
    /**
     * Gets the field's containing oneof, only if non-synthetic.
     *
     * @return null|OneofDescriptor
     */
    public function getRealContainingOneof() {
        return $this->getPublicDescriptor($this->internal_desc
            ->getRealContainingOneof());
    }
    
    /**
     * @return boolean
     */
    public function hasOptionalKeyword() {
        return $this->internal_desc
            ->hasOptionalKeyword();
    }
    
    /**
     * @return Descriptor Returns a descriptor for the field type if the field type is a message, otherwise throws \Exception
     * @throws \Exception
     */
    public function getMessageType() {
        if ($this->getType() == GPBType::MESSAGE) {
            return $this->getPublicDescriptor($this->internal_desc
                ->getMessageType());
        }
        else {
            throw new \Exception("Cannot get message type for non-message field '" . $this->getName() . "'");
        }
    }
    
    /**
     * @return EnumDescriptor Returns an enum descriptor if the field type is an enum, otherwise throws \Exception
     * @throws \Exception
     */
    public function getEnumType() {
        if ($this->getType() == GPBType::ENUM) {
            return $this->getPublicDescriptor($this->internal_desc
                ->getEnumType());
        }
        else {
            throw new \Exception("Cannot get enum type for non-enum field '" . $this->getName() . "'");
        }
    }
    
    /**
     * @return boolean
     */
    public function isMap() {
        return $this->internal_desc
            ->isMap();
    }

}

Members

Title Sort descending Modifiers Object type Summary
FieldDescriptor::$internal_desc private property @var \Google\Protobuf\Internal\FieldDescriptor $internal_desc
FieldDescriptor::getContainingOneof public function
FieldDescriptor::getEnumType public function
FieldDescriptor::getLabel public function
FieldDescriptor::getMessageType public function
FieldDescriptor::getName public function
FieldDescriptor::getNumber public function
FieldDescriptor::getRealContainingOneof public function Gets the field's containing oneof, only if non-synthetic.
FieldDescriptor::getType public function
FieldDescriptor::hasOptionalKeyword public function
FieldDescriptor::isMap public function
FieldDescriptor::__construct public function @internal
GetPublicDescriptorTrait::getPublicDescriptor private function

API Navigation

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