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

Breadcrumb

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

class Field

Same name in this branch
  1. 11.1.x core/modules/field/src/Plugin/migrate/source/d6/Field.php \Drupal\field\Plugin\migrate\source\d6\Field
  2. 11.1.x core/modules/field/src/Plugin/migrate/source/d7/Field.php \Drupal\field\Plugin\migrate\source\d7\Field

A single field of a message type.

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

Hierarchy

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

Expanded class hierarchy of Field

82 string references to 'Field'
BlockContentViewsData::getViewsData in core/modules/block_content/src/BlockContentViewsData.php
Returns views data for the entity type.
Combine::buildOptionsForm in core/modules/views/src/Plugin/views/filter/Combine.php
Provide the basic form which calls through to subforms.
Combine::query in core/modules/views/src/Plugin/views/filter/Combine.php
Add this filter to the query.
Combine::validate in core/modules/views/src/Plugin/views/filter/Combine.php
Validate that the plugin is correct and can be saved.
Comment::defaultDisplayOptions in core/modules/comment/src/Plugin/views/wizard/Comment.php
Assembles the default display options for the view.

... See full list

File

vendor/google/protobuf/src/Google/Protobuf/Field.php, line 16

Namespace

Google\Protobuf
View source
class Field extends \Google\Protobuf\Internal\Message {
    
    /**
     * The field type.
     *
     * Generated from protobuf field <code>.google.protobuf.Field.Kind kind = 1;</code>
     */
    protected $kind = 0;
    
    /**
     * The field cardinality.
     *
     * Generated from protobuf field <code>.google.protobuf.Field.Cardinality cardinality = 2;</code>
     */
    protected $cardinality = 0;
    
    /**
     * The field number.
     *
     * Generated from protobuf field <code>int32 number = 3;</code>
     */
    protected $number = 0;
    
    /**
     * The field name.
     *
     * Generated from protobuf field <code>string name = 4;</code>
     */
    protected $name = '';
    
    /**
     * The field type URL, without the scheme, for message or enumeration
     * types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
     *
     * Generated from protobuf field <code>string type_url = 6;</code>
     */
    protected $type_url = '';
    
    /**
     * The index of the field type in `Type.oneofs`, for message or enumeration
     * types. The first type has index 1; zero means the type is not in the list.
     *
     * Generated from protobuf field <code>int32 oneof_index = 7;</code>
     */
    protected $oneof_index = 0;
    
    /**
     * Whether to use alternative packed wire representation.
     *
     * Generated from protobuf field <code>bool packed = 8;</code>
     */
    protected $packed = false;
    
    /**
     * The protocol buffer options.
     *
     * Generated from protobuf field <code>repeated .google.protobuf.Option options = 9;</code>
     */
    private $options;
    
    /**
     * The field JSON name.
     *
     * Generated from protobuf field <code>string json_name = 10;</code>
     */
    protected $json_name = '';
    
    /**
     * The string value of the default value of this field. Proto2 syntax only.
     *
     * Generated from protobuf field <code>string default_value = 11;</code>
     */
    protected $default_value = '';
    
    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type int $kind
     *           The field type.
     *     @type int $cardinality
     *           The field cardinality.
     *     @type int $number
     *           The field number.
     *     @type string $name
     *           The field name.
     *     @type string $type_url
     *           The field type URL, without the scheme, for message or enumeration
     *           types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
     *     @type int $oneof_index
     *           The index of the field type in `Type.oneofs`, for message or enumeration
     *           types. The first type has index 1; zero means the type is not in the list.
     *     @type bool $packed
     *           Whether to use alternative packed wire representation.
     *     @type array<\Google\Protobuf\Option>|\Google\Protobuf\Internal\RepeatedField $options
     *           The protocol buffer options.
     *     @type string $json_name
     *           The field JSON name.
     *     @type string $default_value
     *           The string value of the default value of this field. Proto2 syntax only.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Protobuf\Type::initOnce();
        parent::__construct($data);
    }
    
    /**
     * The field type.
     *
     * Generated from protobuf field <code>.google.protobuf.Field.Kind kind = 1;</code>
     * @return int
     */
    public function getKind() {
        return $this->kind;
    }
    
    /**
     * The field type.
     *
     * Generated from protobuf field <code>.google.protobuf.Field.Kind kind = 1;</code>
     * @param int $var
     * @return $this
     */
    public function setKind($var) {
        GPBUtil::checkEnum($var, \Google\Protobuf\Field\Kind::class);
        $this->kind = $var;
        return $this;
    }
    
    /**
     * The field cardinality.
     *
     * Generated from protobuf field <code>.google.protobuf.Field.Cardinality cardinality = 2;</code>
     * @return int
     */
    public function getCardinality() {
        return $this->cardinality;
    }
    
    /**
     * The field cardinality.
     *
     * Generated from protobuf field <code>.google.protobuf.Field.Cardinality cardinality = 2;</code>
     * @param int $var
     * @return $this
     */
    public function setCardinality($var) {
        GPBUtil::checkEnum($var, \Google\Protobuf\Field\Cardinality::class);
        $this->cardinality = $var;
        return $this;
    }
    
    /**
     * The field number.
     *
     * Generated from protobuf field <code>int32 number = 3;</code>
     * @return int
     */
    public function getNumber() {
        return $this->number;
    }
    
    /**
     * The field number.
     *
     * Generated from protobuf field <code>int32 number = 3;</code>
     * @param int $var
     * @return $this
     */
    public function setNumber($var) {
        GPBUtil::checkInt32($var);
        $this->number = $var;
        return $this;
    }
    
    /**
     * The field name.
     *
     * Generated from protobuf field <code>string name = 4;</code>
     * @return string
     */
    public function getName() {
        return $this->name;
    }
    
    /**
     * The field name.
     *
     * Generated from protobuf field <code>string name = 4;</code>
     * @param string $var
     * @return $this
     */
    public function setName($var) {
        GPBUtil::checkString($var, True);
        $this->name = $var;
        return $this;
    }
    
    /**
     * The field type URL, without the scheme, for message or enumeration
     * types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
     *
     * Generated from protobuf field <code>string type_url = 6;</code>
     * @return string
     */
    public function getTypeUrl() {
        return $this->type_url;
    }
    
    /**
     * The field type URL, without the scheme, for message or enumeration
     * types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
     *
     * Generated from protobuf field <code>string type_url = 6;</code>
     * @param string $var
     * @return $this
     */
    public function setTypeUrl($var) {
        GPBUtil::checkString($var, True);
        $this->type_url = $var;
        return $this;
    }
    
    /**
     * The index of the field type in `Type.oneofs`, for message or enumeration
     * types. The first type has index 1; zero means the type is not in the list.
     *
     * Generated from protobuf field <code>int32 oneof_index = 7;</code>
     * @return int
     */
    public function getOneofIndex() {
        return $this->oneof_index;
    }
    
    /**
     * The index of the field type in `Type.oneofs`, for message or enumeration
     * types. The first type has index 1; zero means the type is not in the list.
     *
     * Generated from protobuf field <code>int32 oneof_index = 7;</code>
     * @param int $var
     * @return $this
     */
    public function setOneofIndex($var) {
        GPBUtil::checkInt32($var);
        $this->oneof_index = $var;
        return $this;
    }
    
    /**
     * Whether to use alternative packed wire representation.
     *
     * Generated from protobuf field <code>bool packed = 8;</code>
     * @return bool
     */
    public function getPacked() {
        return $this->packed;
    }
    
    /**
     * Whether to use alternative packed wire representation.
     *
     * Generated from protobuf field <code>bool packed = 8;</code>
     * @param bool $var
     * @return $this
     */
    public function setPacked($var) {
        GPBUtil::checkBool($var);
        $this->packed = $var;
        return $this;
    }
    
    /**
     * The protocol buffer options.
     *
     * Generated from protobuf field <code>repeated .google.protobuf.Option options = 9;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getOptions() {
        return $this->options;
    }
    
    /**
     * The protocol buffer options.
     *
     * Generated from protobuf field <code>repeated .google.protobuf.Option options = 9;</code>
     * @param array<\Google\Protobuf\Option>|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setOptions($var) {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Protobuf\Option::class);
        $this->options = $arr;
        return $this;
    }
    
    /**
     * The field JSON name.
     *
     * Generated from protobuf field <code>string json_name = 10;</code>
     * @return string
     */
    public function getJsonName() {
        return $this->json_name;
    }
    
    /**
     * The field JSON name.
     *
     * Generated from protobuf field <code>string json_name = 10;</code>
     * @param string $var
     * @return $this
     */
    public function setJsonName($var) {
        GPBUtil::checkString($var, True);
        $this->json_name = $var;
        return $this;
    }
    
    /**
     * The string value of the default value of this field. Proto2 syntax only.
     *
     * Generated from protobuf field <code>string default_value = 11;</code>
     * @return string
     */
    public function getDefaultValue() {
        return $this->default_value;
    }
    
    /**
     * The string value of the default value of this field. Proto2 syntax only.
     *
     * Generated from protobuf field <code>string default_value = 11;</code>
     * @param string $var
     * @return $this
     */
    public function setDefaultValue($var) {
        GPBUtil::checkString($var, True);
        $this->default_value = $var;
        return $this;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
Field::$cardinality protected property The field cardinality.
Field::$default_value protected property The string value of the default value of this field. Proto2 syntax only.
Field::$json_name protected property The field JSON name.
Field::$kind protected property The field type.
Field::$name protected property The field name.
Field::$number protected property The field number.
Field::$oneof_index protected property The index of the field type in `Type.oneofs`, for message or enumeration
types. The first type has index 1; zero means the type is not in the list.
Field::$options private property The protocol buffer options.
Field::$packed protected property Whether to use alternative packed wire representation.
Field::$type_url protected property The field type URL, without the scheme, for message or enumeration
types. Example: `&quot;type.googleapis.com/google.protobuf.Timestamp&quot;`.
Field::getCardinality public function The field cardinality.
Field::getDefaultValue public function The string value of the default value of this field. Proto2 syntax only.
Field::getJsonName public function The field JSON name.
Field::getKind public function The field type.
Field::getName public function The field name.
Field::getNumber public function The field number.
Field::getOneofIndex public function The index of the field type in `Type.oneofs`, for message or enumeration
types. The first type has index 1; zero means the type is not in the list.
Field::getOptions public function The protocol buffer options.
Field::getPacked public function Whether to use alternative packed wire representation.
Field::getTypeUrl public function The field type URL, without the scheme, for message or enumeration
types. Example: `&quot;type.googleapis.com/google.protobuf.Timestamp&quot;`.
Field::setCardinality public function The field cardinality.
Field::setDefaultValue public function The string value of the default value of this field. Proto2 syntax only.
Field::setJsonName public function The field JSON name.
Field::setKind public function The field type.
Field::setName public function The field name.
Field::setNumber public function The field number.
Field::setOneofIndex public function The index of the field type in `Type.oneofs`, for message or enumeration
types. The first type has index 1; zero means the type is not in the list.
Field::setOptions public function The protocol buffer options.
Field::setPacked public function Whether to use alternative packed wire representation.
Field::setTypeUrl public function The field type URL, without the scheme, for message or enumeration
types. Example: `&quot;type.googleapis.com/google.protobuf.Timestamp&quot;`.
Field::__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
RSS feed
Powered by Drupal