class Enum extends Message (View source)

Enum type definition.

Generated from protobuf message google.protobuf.Enum

Properties

protected $name

Enum type name.

protected $source_context

The source context.

protected $syntax

The source syntax.

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
string
getName()

Enum type name.

$this
setName(string $var)

Enum type name.

getEnumvalue()

Enum value definitions.

$this
setEnumvalue(EnumValue[]|RepeatedField $var)

Enum value definitions.

getOptions()

Protocol buffer options.

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

Protocol buffer options.

getSourceContext()

The source context.

hasSourceContext()

No description

clearSourceContext()

No description

$this
setSourceContext(SourceContext $var)

The source context.

int
getSyntax()

The source syntax.

$this
setSyntax(int $var)

The source syntax.

Details

__construct($data = NULL)

Constructor.

Parameters

$data

protected readWrapperValue($member)

No description

Parameters

$member

protected writeWrapperValue($member, $value)

No description

Parameters

$member
$value

protected readOneof($number)

No description

Parameters

$number

protected hasOneof($number)

No description

Parameters

$number

protected writeOneof($number, $value)

No description

Parameters

$number
$value

protected whichOneof($oneof_name)

No description

Parameters

$oneof_name

clear()

Clear all containing fields.

discardUnknownFields()

Clear all unknown fields previously parsed.

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.

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

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

parseFromStream($input)

No description

Parameters

$input

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.

protected mergeFromJsonArray($array, $ignore_unknown)

No description

Parameters

$array
$ignore_unknown

parseFromJsonStream($input, $ignore_unknown)

No description

Parameters

$input
$ignore_unknown

serializeToStream($output)

No description

Parameters

$output

serializeToJsonStream($output)

No description

Parameters

$output

string serializeToString()

Serialize the message to string.

Return Value

string

Serialized binary protobuf data.

string serializeToJsonString()

Serialize the message to json string.

Return Value

string

Serialized json protobuf data.

byteSize()

No description

jsonByteSize()

No description

string getName()

Enum type name.

Generated from protobuf field string name = 1;

Return Value

string

$this setName(string $var)

Enum type name.

Generated from protobuf field string name = 1;

Parameters

string $var

Return Value

$this

RepeatedField getEnumvalue()

Enum value definitions.

Generated from protobuf field repeated .google.protobuf.EnumValue enumvalue = 2;

Return Value

RepeatedField

$this setEnumvalue(EnumValue[]|RepeatedField $var)

Enum value definitions.

Generated from protobuf field repeated .google.protobuf.EnumValue enumvalue = 2;

Parameters

EnumValue[]|RepeatedField $var

Return Value

$this

RepeatedField getOptions()

Protocol buffer options.

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

Return Value

RepeatedField

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

Protocol buffer options.

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

Parameters

Option[]|RepeatedField $var

Return Value

$this

SourceContext|null getSourceContext()

The source context.

Generated from protobuf field .google.protobuf.SourceContext source_context = 4;

Return Value

SourceContext|null

hasSourceContext()

No description

clearSourceContext()

No description

$this setSourceContext(SourceContext $var)

The source context.

Generated from protobuf field .google.protobuf.SourceContext source_context = 4;

Parameters

SourceContext $var

Return Value

$this

int getSyntax()

The source syntax.

Generated from protobuf field .google.protobuf.Syntax syntax = 5;

Return Value

int

$this setSyntax(int $var)

The source syntax.

Generated from protobuf field .google.protobuf.Syntax syntax = 5;

Parameters

int $var

Return Value

$this