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

Field

class Field extends Message (View source)

A single field of a message type.

Generated from protobuf message google.protobuf.Field

Properties

protected $kind

The field type.
protected $cardinality

The field cardinality.
protected $number

The field number.
protected $name

The field name.
protected $type_url

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".
protected $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.
protected $packed

Whether to use alternative packed wire representation.
protected $json_name

The field JSON name.
protected $default_value

The string value of the default value of this field. Proto2 syntax only.

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
getKind()

The field type.

$this
setKind(int $var)

The field type.

int
getCardinality()

The field cardinality.

$this
setCardinality(int $var)

The field cardinality.

int
getNumber()

The field number.

$this
setNumber(int $var)

The field number.

string
getName()

The field name.

$this
setName(string $var)

The field name.

string
getTypeUrl()

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

$this
setTypeUrl(string $var)

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

int
getOneofIndex()

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.

$this
setOneofIndex(int $var)

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.

bool
getPacked()

Whether to use alternative packed wire representation.

$this
setPacked(bool $var)

Whether to use alternative packed wire representation.

RepeatedField
getOptions()

The protocol buffer options.

$this
setOptions(Option[]|RepeatedField $var)

The protocol buffer options.

string
getJsonName()

The field JSON name.

$this
setJsonName(string $var)

The field JSON name.

string
getDefaultValue()

The string value of the default value of this field. Proto2 syntax only.

$this
setDefaultValue(string $var)

The string value of the default value of this field. Proto2 syntax only.

Details

at line 111
__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 122
int getKind()

The field type.

Generated from protobuf field .google.protobuf.Field.Kind kind = 1;

Return Value

int

at line 134
$this setKind(int $var)

The field type.

Generated from protobuf field .google.protobuf.Field.Kind kind = 1;

Parameters

int $var

Return Value

$this

at line 148
int getCardinality()

The field cardinality.

Generated from protobuf field .google.protobuf.Field.Cardinality cardinality = 2;

Return Value

int

at line 160
$this setCardinality(int $var)

The field cardinality.

Generated from protobuf field .google.protobuf.Field.Cardinality cardinality = 2;

Parameters

int $var

Return Value

$this

at line 174
int getNumber()

The field number.

Generated from protobuf field int32 number = 3;

Return Value

int

at line 186
$this setNumber(int $var)

The field number.

Generated from protobuf field int32 number = 3;

Parameters

int $var

Return Value

$this

at line 200
string getName()

The field name.

Generated from protobuf field string name = 4;

Return Value

string

at line 212
$this setName(string $var)

The field name.

Generated from protobuf field string name = 4;

Parameters

string $var

Return Value

$this

at line 227
string getTypeUrl()

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

Generated from protobuf field string type_url = 6;

Return Value

string

at line 240
$this setTypeUrl(string $var)

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

Generated from protobuf field string type_url = 6;

Parameters

string $var

Return Value

$this

at line 255
int getOneofIndex()

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 int32 oneof_index = 7;

Return Value

int

at line 268
$this setOneofIndex(int $var)

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 int32 oneof_index = 7;

Parameters

int $var

Return Value

$this

at line 282
bool getPacked()

Whether to use alternative packed wire representation.

Generated from protobuf field bool packed = 8;

Return Value

bool

at line 294
$this setPacked(bool $var)

Whether to use alternative packed wire representation.

Generated from protobuf field bool packed = 8;

Parameters

bool $var

Return Value

$this

at line 308
RepeatedField getOptions()

The protocol buffer options.

Generated from protobuf field repeated .google.protobuf.Option options = 9;

Return Value

RepeatedField

at line 320
$this setOptions(Option[]|RepeatedField $var)

The protocol buffer options.

Generated from protobuf field repeated .google.protobuf.Option options = 9;

Parameters

Option[]|RepeatedField $var

Return Value

$this

at line 334
string getJsonName()

The field JSON name.

Generated from protobuf field string json_name = 10;

Return Value

string

at line 346
$this setJsonName(string $var)

The field JSON name.

Generated from protobuf field string json_name = 10;

Parameters

string $var

Return Value

$this

at line 360
string getDefaultValue()

The string value of the default value of this field. Proto2 syntax only.

Generated from protobuf field string default_value = 11;

Return Value

string

at line 372
$this setDefaultValue(string $var)

The string value of the default value of this field. Proto2 syntax only.

Generated from protobuf field string default_value = 11;

Parameters

string $var

Return Value

$this