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

Breadcrumb

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

class Annotation

Same name in this branch
  1. 11.1.x vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/Annotation.php \Doctrine\Common\Annotations\Annotation
  2. 11.1.x vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/Annotation.php \SlevomatCodingStandard\Helpers\Annotation

Generated from protobuf message <code>google.protobuf.GeneratedCodeInfo.Annotation</code>

Hierarchy

  • class \Google\Protobuf\Internal\Message
    • class \Google\Protobuf\Internal\GeneratedCodeInfo\Annotation extends \Google\Protobuf\Internal\Message

Expanded class hierarchy of Annotation

1 string reference to 'Annotation'
AnnotationHelper::processDocComment in vendor/phpstan/phpstan-phpunit/src/Rules/PHPUnit/AnnotationHelper.php
*

File

vendor/google/protobuf/src/Google/Protobuf/Internal/GeneratedCodeInfo/Annotation.php, line 16

Namespace

Google\Protobuf\Internal\GeneratedCodeInfo
View source
class Annotation extends \Google\Protobuf\Internal\Message {
    
    /**
     * Identifies the element in the original source .proto file. This field
     * is formatted the same as SourceCodeInfo.Location.path.
     *
     * Generated from protobuf field <code>repeated int32 path = 1 [packed = true];</code>
     */
    private $path;
    
    /**
     * Identifies the filesystem path to the original source .proto.
     *
     * Generated from protobuf field <code>optional string source_file = 2;</code>
     */
    protected $source_file = null;
    
    /**
     * Identifies the starting offset in bytes in the generated code
     * that relates to the identified object.
     *
     * Generated from protobuf field <code>optional int32 begin = 3;</code>
     */
    protected $begin = null;
    
    /**
     * Identifies the ending offset in bytes in the generated code that
     * relates to the identified object. The end offset should be one past
     * the last relevant byte (so the length of the text = end - begin).
     *
     * Generated from protobuf field <code>optional int32 end = 4;</code>
     */
    protected $end = null;
    
    /**
     * Generated from protobuf field <code>optional .google.protobuf.GeneratedCodeInfo.Annotation.Semantic semantic = 5;</code>
     */
    protected $semantic = null;
    
    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type array<int>|\Google\Protobuf\Internal\RepeatedField $path
     *           Identifies the element in the original source .proto file. This field
     *           is formatted the same as SourceCodeInfo.Location.path.
     *     @type string $source_file
     *           Identifies the filesystem path to the original source .proto.
     *     @type int $begin
     *           Identifies the starting offset in bytes in the generated code
     *           that relates to the identified object.
     *     @type int $end
     *           Identifies the ending offset in bytes in the generated code that
     *           relates to the identified object. The end offset should be one past
     *           the last relevant byte (so the length of the text = end - begin).
     *     @type int $semantic
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Protobuf\Internal\Descriptor::initOnce();
        parent::__construct($data);
    }
    
    /**
     * Identifies the element in the original source .proto file. This field
     * is formatted the same as SourceCodeInfo.Location.path.
     *
     * Generated from protobuf field <code>repeated int32 path = 1 [packed = true];</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getPath() {
        return $this->path;
    }
    
    /**
     * Identifies the element in the original source .proto file. This field
     * is formatted the same as SourceCodeInfo.Location.path.
     *
     * Generated from protobuf field <code>repeated int32 path = 1 [packed = true];</code>
     * @param array<int>|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setPath($var) {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT32);
        $this->path = $arr;
        return $this;
    }
    
    /**
     * Identifies the filesystem path to the original source .proto.
     *
     * Generated from protobuf field <code>optional string source_file = 2;</code>
     * @return string
     */
    public function getSourceFile() {
        return isset($this->source_file) ? $this->source_file : '';
    }
    public function hasSourceFile() {
        return isset($this->source_file);
    }
    public function clearSourceFile() {
        unset($this->source_file);
    }
    
    /**
     * Identifies the filesystem path to the original source .proto.
     *
     * Generated from protobuf field <code>optional string source_file = 2;</code>
     * @param string $var
     * @return $this
     */
    public function setSourceFile($var) {
        GPBUtil::checkString($var, True);
        $this->source_file = $var;
        return $this;
    }
    
    /**
     * Identifies the starting offset in bytes in the generated code
     * that relates to the identified object.
     *
     * Generated from protobuf field <code>optional int32 begin = 3;</code>
     * @return int
     */
    public function getBegin() {
        return isset($this->begin) ? $this->begin : 0;
    }
    public function hasBegin() {
        return isset($this->begin);
    }
    public function clearBegin() {
        unset($this->begin);
    }
    
    /**
     * Identifies the starting offset in bytes in the generated code
     * that relates to the identified object.
     *
     * Generated from protobuf field <code>optional int32 begin = 3;</code>
     * @param int $var
     * @return $this
     */
    public function setBegin($var) {
        GPBUtil::checkInt32($var);
        $this->begin = $var;
        return $this;
    }
    
    /**
     * Identifies the ending offset in bytes in the generated code that
     * relates to the identified object. The end offset should be one past
     * the last relevant byte (so the length of the text = end - begin).
     *
     * Generated from protobuf field <code>optional int32 end = 4;</code>
     * @return int
     */
    public function getEnd() {
        return isset($this->end) ? $this->end : 0;
    }
    public function hasEnd() {
        return isset($this->end);
    }
    public function clearEnd() {
        unset($this->end);
    }
    
    /**
     * Identifies the ending offset in bytes in the generated code that
     * relates to the identified object. The end offset should be one past
     * the last relevant byte (so the length of the text = end - begin).
     *
     * Generated from protobuf field <code>optional int32 end = 4;</code>
     * @param int $var
     * @return $this
     */
    public function setEnd($var) {
        GPBUtil::checkInt32($var);
        $this->end = $var;
        return $this;
    }
    
    /**
     * Generated from protobuf field <code>optional .google.protobuf.GeneratedCodeInfo.Annotation.Semantic semantic = 5;</code>
     * @return int
     */
    public function getSemantic() {
        return isset($this->semantic) ? $this->semantic : 0;
    }
    public function hasSemantic() {
        return isset($this->semantic);
    }
    public function clearSemantic() {
        unset($this->semantic);
    }
    
    /**
     * Generated from protobuf field <code>optional .google.protobuf.GeneratedCodeInfo.Annotation.Semantic semantic = 5;</code>
     * @param int $var
     * @return $this
     */
    public function setSemantic($var) {
        GPBUtil::checkEnum($var, \Google\Protobuf\Internal\GeneratedCodeInfo\Annotation\Semantic::class);
        $this->semantic = $var;
        return $this;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
Annotation::$begin protected property Identifies the starting offset in bytes in the generated code
that relates to the identified object.
Annotation::$end protected property Identifies the ending offset in bytes in the generated code that
relates to the identified object. The end offset should be one past
the last relevant byte (so the length of the text = end - begin).
Annotation::$path private property Identifies the element in the original source .proto file. This field
is formatted the same as SourceCodeInfo.Location.path.
Annotation::$semantic protected property Generated from protobuf field &lt;code&gt;optional .google.protobuf.GeneratedCodeInfo.Annotation.Semantic semantic = 5;&lt;/code&gt;
Annotation::$source_file protected property Identifies the filesystem path to the original source .proto.
Annotation::clearBegin public function
Annotation::clearEnd public function
Annotation::clearSemantic public function
Annotation::clearSourceFile public function
Annotation::getBegin public function Identifies the starting offset in bytes in the generated code
that relates to the identified object.
Annotation::getEnd public function Identifies the ending offset in bytes in the generated code that
relates to the identified object. The end offset should be one past
the last relevant byte (so the length of the text = end - begin).
Annotation::getPath public function Identifies the element in the original source .proto file. This field
is formatted the same as SourceCodeInfo.Location.path.
Annotation::getSemantic public function Generated from protobuf field &lt;code&gt;optional .google.protobuf.GeneratedCodeInfo.Annotation.Semantic semantic = 5;&lt;/code&gt;
Annotation::getSourceFile public function Identifies the filesystem path to the original source .proto.
Annotation::hasBegin public function
Annotation::hasEnd public function
Annotation::hasSemantic public function
Annotation::hasSourceFile public function
Annotation::setBegin public function Identifies the starting offset in bytes in the generated code
that relates to the identified object.
Annotation::setEnd public function Identifies the ending offset in bytes in the generated code that
relates to the identified object. The end offset should be one past
the last relevant byte (so the length of the text = end - begin).
Annotation::setPath public function Identifies the element in the original source .proto file. This field
is formatted the same as SourceCodeInfo.Location.path.
Annotation::setSemantic public function Generated from protobuf field &lt;code&gt;optional .google.protobuf.GeneratedCodeInfo.Annotation.Semantic semantic = 5;&lt;/code&gt;
Annotation::setSourceFile public function Identifies the filesystem path to the original source .proto.
Annotation::__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