PHPFUI/InstaDoc
 
Copied!

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 google.protobuf.Value

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

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 Google\Protobuf\Internal\Message::__debugInfo()
public Google\Protobuf\Internal\Message::byteSize()
 
  • ignore
public Google\Protobuf\Internal\Message::clear()
 

Clear all containing fields.

  • return null
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getBoolValue()
 

Represents a boolean value.

Generated from protobuf field bool bool_value = 4;

  • return bool
public getKind()
 
  • return string
public getListValue()
 

Represents a repeated Value.

Generated from protobuf field .google.protobuf.ListValue list_value = 6;

  • return \Google\Protobuf\ListValue|null
public getNullValue()
 

Represents a null value.

Generated from protobuf field .google.protobuf.NullValue null_value = 1;

  • return int
public getNumberValue()
 

Represents a double value.

Generated from protobuf field double number_value = 2;

  • return float
public getStringValue()
 

Represents a string value.

Generated from protobuf field string string_value = 3;

  • return string
public getStructValue()
 

Represents a structured value.

Generated from protobuf field .google.protobuf.Struct struct_value = 5;

  • return \Google\Protobuf\Struct|null
public hasBoolValue()
public hasListValue()
public hasNullValue()
public hasNumberValue()
public hasStringValue()
public hasStructValue()
public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)
 
  • ignore
public Google\Protobuf\Internal\Message::mergeFrom( $msg)
 

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

  • param object $msg Protobuf message to be merged from.
  • return null
public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
 

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Json protobuf data.
  • param bool $ignore_unknown
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::mergeFromString( $data)
 

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Binary protobuf data.
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
 
  • ignore
public Google\Protobuf\Internal\Message::parseFromStream( $input)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)
 

Serialize the message to json string.

  • return string Serialized json protobuf data.
public Google\Protobuf\Internal\Message::serializeToStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToString()
 

Serialize the message to string.

  • return string Serialized binary protobuf data.
public setBoolValue( $var)
 

Represents a boolean value.

Generated from protobuf field bool bool_value = 4;

  • param bool $var
  • return $this
public setListValue( $var)
 

Represents a repeated Value.

Generated from protobuf field .google.protobuf.ListValue list_value = 6;

  • param \Google\Protobuf\ListValue $var
  • return $this
public setNullValue( $var)
 

Represents a null value.

Generated from protobuf field .google.protobuf.NullValue null_value = 1;

  • param int $var
  • return $this
public setNumberValue( $var)
 

Represents a double value.

Generated from protobuf field double number_value = 2;

  • param float $var
  • return $this
public setStringValue( $var)
 

Represents a string value.

Generated from protobuf field string string_value = 3;

  • param string $var
  • return $this
public setStructValue( $var)
 

Represents a structured value.

Generated from protobuf field .google.protobuf.Struct struct_value = 5;

  • param \Google\Protobuf\Struct $var
  • return $this
Properties
protected $kind = NULL
Methods
protected Google\Protobuf\Internal\Message::hasOneof( $number)
protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
 

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

  • param array $array An array containing message properties and values.
  • return null
protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
protected Google\Protobuf\Internal\Message::readOneof( $number)
protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration