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

Breadcrumb

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

class Value

Same name in this branch
  1. 11.1.x core/lib/Drupal/Core/Render/Element/Value.php \Drupal\Core\Render\Element\Value

`Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for `Value` is JSON value.

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

Hierarchy

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

Expanded class hierarchy of Value

1 file declares its use of Value
Message.php in vendor/google/protobuf/src/Google/Protobuf/Internal/Message.php
194 string references to 'Value'
AbstractComparison::getDefaultOption in vendor/symfony/validator/Constraints/AbstractComparison.php
Returns the name of the default option.
AbstractWebDriver::curl in vendor/lullabot/php-webdriver/lib/WebDriver/AbstractWebDriver.php
Curl request to webdriver server.
AnyValue::getValue in vendor/open-telemetry/gen-otlp-protobuf/Opentelemetry/Proto/Common/V1/AnyValue.php
Arg::getSubNodeNames in vendor/nikic/php-parser/lib/PhpParser/Node/Arg.php
Gets the names of the sub nodes.
ArrayExpression::compile in vendor/twig/twig/src/Node/Expression/ArrayExpression.php

... See full list

File

vendor/google/protobuf/src/Google/Protobuf/Value.php, line 20

Namespace

Google\Protobuf
View source
class Value extends \Google\Protobuf\Internal\Message {
    protected $kind;
    
    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type int $null_value
     *           Represents a null value.
     *     @type float $number_value
     *           Represents a double value.
     *     @type string $string_value
     *           Represents a string value.
     *     @type bool $bool_value
     *           Represents a boolean value.
     *     @type \Google\Protobuf\Struct $struct_value
     *           Represents a structured value.
     *     @type \Google\Protobuf\ListValue $list_value
     *           Represents a repeated `Value`.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Protobuf\Struct::initOnce();
        parent::__construct($data);
    }
    
    /**
     * Represents a null value.
     *
     * Generated from protobuf field <code>.google.protobuf.NullValue null_value = 1;</code>
     * @return int
     */
    public function getNullValue() {
        return $this->readOneof(1);
    }
    public function hasNullValue() {
        return $this->hasOneof(1);
    }
    
    /**
     * Represents a null value.
     *
     * Generated from protobuf field <code>.google.protobuf.NullValue null_value = 1;</code>
     * @param int $var
     * @return $this
     */
    public function setNullValue($var) {
        GPBUtil::checkEnum($var, \Google\Protobuf\NullValue::class);
        $this->writeOneof(1, $var);
        return $this;
    }
    
    /**
     * Represents a double value.
     *
     * Generated from protobuf field <code>double number_value = 2;</code>
     * @return float
     */
    public function getNumberValue() {
        return $this->readOneof(2);
    }
    public function hasNumberValue() {
        return $this->hasOneof(2);
    }
    
    /**
     * Represents a double value.
     *
     * Generated from protobuf field <code>double number_value = 2;</code>
     * @param float $var
     * @return $this
     */
    public function setNumberValue($var) {
        GPBUtil::checkDouble($var);
        $this->writeOneof(2, $var);
        return $this;
    }
    
    /**
     * Represents a string value.
     *
     * Generated from protobuf field <code>string string_value = 3;</code>
     * @return string
     */
    public function getStringValue() {
        return $this->readOneof(3);
    }
    public function hasStringValue() {
        return $this->hasOneof(3);
    }
    
    /**
     * Represents a string value.
     *
     * Generated from protobuf field <code>string string_value = 3;</code>
     * @param string $var
     * @return $this
     */
    public function setStringValue($var) {
        GPBUtil::checkString($var, True);
        $this->writeOneof(3, $var);
        return $this;
    }
    
    /**
     * Represents a boolean value.
     *
     * Generated from protobuf field <code>bool bool_value = 4;</code>
     * @return bool
     */
    public function getBoolValue() {
        return $this->readOneof(4);
    }
    public function hasBoolValue() {
        return $this->hasOneof(4);
    }
    
    /**
     * Represents a boolean value.
     *
     * Generated from protobuf field <code>bool bool_value = 4;</code>
     * @param bool $var
     * @return $this
     */
    public function setBoolValue($var) {
        GPBUtil::checkBool($var);
        $this->writeOneof(4, $var);
        return $this;
    }
    
    /**
     * Represents a structured value.
     *
     * Generated from protobuf field <code>.google.protobuf.Struct struct_value = 5;</code>
     * @return \Google\Protobuf\Struct|null
     */
    public function getStructValue() {
        return $this->readOneof(5);
    }
    public function hasStructValue() {
        return $this->hasOneof(5);
    }
    
    /**
     * Represents a structured value.
     *
     * Generated from protobuf field <code>.google.protobuf.Struct struct_value = 5;</code>
     * @param \Google\Protobuf\Struct $var
     * @return $this
     */
    public function setStructValue($var) {
        GPBUtil::checkMessage($var, \Google\Protobuf\Struct::class);
        $this->writeOneof(5, $var);
        return $this;
    }
    
    /**
     * Represents a repeated `Value`.
     *
     * Generated from protobuf field <code>.google.protobuf.ListValue list_value = 6;</code>
     * @return \Google\Protobuf\ListValue|null
     */
    public function getListValue() {
        return $this->readOneof(6);
    }
    public function hasListValue() {
        return $this->hasOneof(6);
    }
    
    /**
     * Represents a repeated `Value`.
     *
     * Generated from protobuf field <code>.google.protobuf.ListValue list_value = 6;</code>
     * @param \Google\Protobuf\ListValue $var
     * @return $this
     */
    public function setListValue($var) {
        GPBUtil::checkMessage($var, \Google\Protobuf\ListValue::class);
        $this->writeOneof(6, $var);
        return $this;
    }
    
    /**
     * @return string
     */
    public function getKind() {
        return $this->whichOneof("kind");
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
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
Value::$kind protected property
Value::getBoolValue public function Represents a boolean value.
Value::getKind public function
Value::getListValue public function Represents a repeated `Value`.
Value::getNullValue public function Represents a null value.
Value::getNumberValue public function Represents a double value.
Value::getStringValue public function Represents a string value.
Value::getStructValue public function Represents a structured value.
Value::hasBoolValue public function
Value::hasListValue public function
Value::hasNullValue public function
Value::hasNumberValue public function
Value::hasStringValue public function
Value::hasStructValue public function
Value::setBoolValue public function Represents a boolean value.
Value::setListValue public function Represents a repeated `Value`.
Value::setNullValue public function Represents a null value.
Value::setNumberValue public function Represents a double value.
Value::setStringValue public function Represents a string value.
Value::setStructValue public function Represents a structured value.
Value::__construct public function Constructor. Overrides Message::__construct

API Navigation

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