class FeatureSupport extends Message (View source)

Information about the support window of a feature.

Generated from protobuf message google.protobuf.FieldOptions.FeatureSupport

Properties

protected $edition_introduced

The edition that this feature was first available in. In editions earlier than this one, the default assigned to EDITION_LEGACY will be used, and proto files will not be able to override it.

protected $edition_deprecated

The edition this feature becomes deprecated in. Using this after this edition may trigger warnings.

protected $deprecation_warning

The deprecation warning text if this feature is used after the edition it was marked deprecated in.

protected $edition_removed

The edition this feature is no longer available in. In editions after this one, the last default assigned will be used, and proto files will not be able to override it.

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
null
clear()

Clear all containing fields.

from  Message
null
discardUnknownFields()

Clear all unknown fields previously parsed.

from  Message
null
mergeFrom(object $msg)

Merges the contents of the specified message into current message.

from  Message
null
mergeFromString(string $data)

Parses a protocol buffer contained in a string.

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

Parses a json string to protobuf message.

from  Message
parseFromStream($input)

No description

from  Message
null
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($options = 0)

Serialize the message to json string.

from  Message
byteSize()

No description

from  Message
jsonByteSize($options = 0)

No description

from  Message
__debugInfo()

No description

from  Message
int
getEditionIntroduced()

The edition that this feature was first available in. In editions earlier than this one, the default assigned to EDITION_LEGACY will be used, and proto files will not be able to override it.

hasEditionIntroduced()

No description

clearEditionIntroduced()

No description

$this
setEditionIntroduced(int $var)

The edition that this feature was first available in. In editions earlier than this one, the default assigned to EDITION_LEGACY will be used, and proto files will not be able to override it.

int
getEditionDeprecated()

The edition this feature becomes deprecated in. Using this after this edition may trigger warnings.

hasEditionDeprecated()

No description

clearEditionDeprecated()

No description

$this
setEditionDeprecated(int $var)

The edition this feature becomes deprecated in. Using this after this edition may trigger warnings.

string
getDeprecationWarning()

The deprecation warning text if this feature is used after the edition it was marked deprecated in.

hasDeprecationWarning()

No description

clearDeprecationWarning()

No description

$this
setDeprecationWarning(string $var)

The deprecation warning text if this feature is used after the edition it was marked deprecated in.

int
getEditionRemoved()

The edition this feature is no longer available in. In editions after this one, the last default assigned will be used, and proto files will not be able to override it.

hasEditionRemoved()

No description

clearEditionRemoved()

No description

$this
setEditionRemoved(int $var)

The edition this feature is no longer available in. In editions after this one, the last default assigned will be used, and proto files will not be able to override it.

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

null clear()

Clear all containing fields.

Return Value

null

null discardUnknownFields()

Clear all unknown fields previously parsed.

Return Value

null

null 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.

Return Value

null

null 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.

Return Value

null

Exceptions

Exception

null mergeFromJsonString(string $data, bool $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.

bool $ignore_unknown

Return Value

null

Exceptions

Exception

parseFromStream($input)

No description

Parameters

$input

protected null 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.

Return Value

null

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($options = 0)

Serialize the message to json string.

Parameters

$options

Return Value

string

Serialized json protobuf data.

byteSize()

No description

jsonByteSize($options = 0)

No description

Parameters

$options

__debugInfo()

No description

int getEditionIntroduced()

The edition that this feature was first available in. In editions earlier than this one, the default assigned to EDITION_LEGACY will be used, and proto files will not be able to override it.

Generated from protobuf field optional .google.protobuf.Edition edition_introduced = 1;

Return Value

int

hasEditionIntroduced()

No description

clearEditionIntroduced()

No description

$this setEditionIntroduced(int $var)

The edition that this feature was first available in. In editions earlier than this one, the default assigned to EDITION_LEGACY will be used, and proto files will not be able to override it.

Generated from protobuf field optional .google.protobuf.Edition edition_introduced = 1;

Parameters

int $var

Return Value

$this

int getEditionDeprecated()

The edition this feature becomes deprecated in. Using this after this edition may trigger warnings.

Generated from protobuf field optional .google.protobuf.Edition edition_deprecated = 2;

Return Value

int

hasEditionDeprecated()

No description

clearEditionDeprecated()

No description

$this setEditionDeprecated(int $var)

The edition this feature becomes deprecated in. Using this after this edition may trigger warnings.

Generated from protobuf field optional .google.protobuf.Edition edition_deprecated = 2;

Parameters

int $var

Return Value

$this

string getDeprecationWarning()

The deprecation warning text if this feature is used after the edition it was marked deprecated in.

Generated from protobuf field optional string deprecation_warning = 3;

Return Value

string

hasDeprecationWarning()

No description

clearDeprecationWarning()

No description

$this setDeprecationWarning(string $var)

The deprecation warning text if this feature is used after the edition it was marked deprecated in.

Generated from protobuf field optional string deprecation_warning = 3;

Parameters

string $var

Return Value

$this

int getEditionRemoved()

The edition this feature is no longer available in. In editions after this one, the last default assigned will be used, and proto files will not be able to override it.

Generated from protobuf field optional .google.protobuf.Edition edition_removed = 4;

Return Value

int

hasEditionRemoved()

No description

clearEditionRemoved()

No description

$this setEditionRemoved(int $var)

The edition this feature is no longer available in. In editions after this one, the last default assigned will be used, and proto files will not be able to override it.

Generated from protobuf field optional .google.protobuf.Edition edition_removed = 4;

Parameters

int $var

Return Value

$this