1. class
  2. Google
  3. \
  4. Protobuf
  5. \
  6. Value

Value

class Value extends Message (View source)

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

Properties

protected $kind

Methods

__construct($data = NULL)

Constructor.

readWrapperValue($member)

No description

from  Message
writeWrapperValue($member, $value)

No description

from  Message
readOneof($number)

No description

from  Message
hasOneof($number)

No description

from  Message
writeOneof($number, $value)

No description

from  Message
whichOneof($oneof_name)

No description

from  Message
clear()

Clear all containing fields.

from  Message
discardUnknownFields()

Clear all unknown fields previously parsed.

from  Message
mergeFrom(object $msg)

Merges the contents of the specified message into current message.

from  Message
mergeFromString(string $data)

Parses a protocol buffer contained in a string.

from  Message
mergeFromJsonString(string $data, $ignore_unknown = false)

Parses a json string to protobuf message.

from  Message
parseFromStream($input)

No description

from  Message
mergeFromArray(array $array)

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

from  Message
mergeFromJsonArray($array, $ignore_unknown)

No description

from  Message
parseFromJsonStream($input, $ignore_unknown)

No description

from  Message
serializeToStream($output)

No description

from  Message
serializeToJsonStream($output)

No description

from  Message
string
serializeToString()

Serialize the message to string.

from  Message
string
serializeToJsonString()

Serialize the message to json string.

from  Message
byteSize()

No description

from  Message
jsonByteSize()

No description

from  Message
int
getNullValue()

Represents a null value.

hasNullValue()

No description

$this
setNullValue(int $var)

Represents a null value.

float
getNumberValue()

Represents a double value.

hasNumberValue()

No description

$this
setNumberValue(float $var)

Represents a double value.

string
getStringValue()

Represents a string value.

hasStringValue()

No description

$this
setStringValue(string $var)

Represents a string value.

bool
getBoolValue()

Represents a boolean value.

hasBoolValue()

No description

$this
setBoolValue(bool $var)

Represents a boolean value.

Struct|null
getStructValue()

Represents a structured value.

hasStructValue()

No description

$this
setStructValue(Struct $var)

Represents a structured value.

ListValue|null
getListValue()

Represents a repeated Value.

hasListValue()

No description

$this
setListValue(ListValue $var)

Represents a repeated Value.

string
getKind()

No description

Details

at line 44
__construct($data = NULL)

Constructor.

Parameters

$data

in Message at line 180
protected readWrapperValue($member)

No description

Parameters

$member

in Message at line 197
protected writeWrapperValue($member, $value)

No description

Parameters

$member
$value

in Message at line 216
protected readOneof($number)

No description

Parameters

$number

in Message at line 229
protected hasOneof($number)

No description

Parameters

$number

in Message at line 238
protected writeOneof($number, $value)

No description

Parameters

$number
$value

in Message at line 253
protected whichOneof($oneof_name)

No description

Parameters

$oneof_name

in Message at line 548
clear()

Clear all containing fields.

in Message at line 658
discardUnknownFields()

Clear all unknown fields previously parsed.

in Message at line 704
mergeFrom(object $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.

Parameters

object $msg

Protobuf message to be merged from.

in Message at line 772
mergeFromString(string $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.

Parameters

string $data

Binary protobuf data.

Exceptions

Exception

in Message at line 790
mergeFromJsonString(string $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.

Parameters

string $data

Json protobuf data.
$ignore_unknown

Exceptions

Exception

in Message at line 799
parseFromStream($input)

No description

Parameters

$input

in Message at line 1057
protected 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.

Parameters

array $array

An array containing message properties and values.

in Message at line 1146
protected mergeFromJsonArray($array, $ignore_unknown)

No description

Parameters

$array
$ignore_unknown

in Message at line 1320
parseFromJsonStream($input, $ignore_unknown)

No description

Parameters

$input
$ignore_unknown

in Message at line 1453
serializeToStream($output)

No description

Parameters

$output

in Message at line 1468
serializeToJsonStream($output)

No description

Parameters

$output

in Message at line 1560
string serializeToString()

Serialize the message to string.

Return Value

string

Serialized binary protobuf data.

in Message at line 1571
string serializeToJsonString()

Serialize the message to json string.

Return Value

string

Serialized json protobuf data.

in Message at line 1923
byteSize()

No description

in Message at line 1964
jsonByteSize()

No description

at line 55
int getNullValue()

Represents a null value.

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

Return Value

int

at line 60
hasNullValue()

No description

at line 72
$this setNullValue(int $var)

Represents a null value.

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

Parameters

int $var

Return Value

$this

at line 86
float getNumberValue()

Represents a double value.

Generated from protobuf field double number_value = 2;

Return Value

float

at line 91
hasNumberValue()

No description

at line 103
$this setNumberValue(float $var)

Represents a double value.

Generated from protobuf field double number_value = 2;

Parameters

float $var

Return Value

$this

at line 117
string getStringValue()

Represents a string value.

Generated from protobuf field string string_value = 3;

Return Value

string

at line 122
hasStringValue()

No description

at line 134
$this setStringValue(string $var)

Represents a string value.

Generated from protobuf field string string_value = 3;

Parameters

string $var

Return Value

$this

at line 148
bool getBoolValue()

Represents a boolean value.

Generated from protobuf field bool bool_value = 4;

Return Value

bool

at line 153
hasBoolValue()

No description

at line 165
$this setBoolValue(bool $var)

Represents a boolean value.

Generated from protobuf field bool bool_value = 4;

Parameters

bool $var

Return Value

$this

at line 179
Struct|null getStructValue()

Represents a structured value.

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

Return Value

Struct|null

at line 184
hasStructValue()

No description

at line 196
$this setStructValue(Struct $var)

Represents a structured value.

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

Parameters

Struct $var

Return Value

$this

at line 210
ListValue|null getListValue()

Represents a repeated Value.

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

Return Value

ListValue|null

at line 215
hasListValue()

No description

at line 227
$this setListValue(ListValue $var)

Represents a repeated Value.

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

Parameters

ListValue $var

Return Value

$this

at line 238
string getKind()

No description

Return Value

string