PHPFUI/InstaDoc
 
Copied!

Information about the support window of a feature.

Generated from protobuf message google.protobuf.FieldOptions.FeatureSupport

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type int $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.
@type int $edition_deprecated
      The edition this feature becomes deprecated in.  Using this after this
      edition may trigger warnings.
@type string $deprecation_warning
      The deprecation warning text if this feature is used after the edition it
      was marked deprecated in.
@type int $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.
@type string $removal_error
      The removal error text if this feature is used after the edition it was
      removed in.
    }
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 clearDeprecationWarning()
public clearEditionDeprecated()
public clearEditionIntroduced()
public clearEditionRemoved()
public clearRemovalError()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public 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 string
public 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 int one of the values in {@see \Google\Protobuf\Internal\Edition}
public 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 int one of the values in {@see \Google\Protobuf\Internal\Edition}
public 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 int one of the values in {@see \Google\Protobuf\Internal\Edition}
public getRemovalError()
 

The removal error text if this feature is used after the edition it was removed in.

Generated from protobuf field optional string removal_error = 5;

  • return string
public hasDeprecationWarning()
public hasEditionDeprecated()
public hasEditionIntroduced()
public hasEditionRemoved()
public hasRemovalError()
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 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;

  • param string $var
  • return $this
public 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;

  • param int $var one of the values in {@see \Google\Protobuf\Internal\Edition}
  • return $this
public 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;

  • param int $var one of the values in {@see \Google\Protobuf\Internal\Edition}
  • return $this
public 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;

  • param int $var one of the values in {@see \Google\Protobuf\Internal\Edition}
  • return $this
public setRemovalError(string $var)
 

The removal error text if this feature is used after the edition it was removed in.

Generated from protobuf field optional string removal_error = 5;

  • param string $var
  • return $this
Properties
protected $deprecation_warning = NULL
 

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;

protected $edition_deprecated = NULL
 

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;

protected $edition_introduced = NULL
 

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;

protected $edition_removed = NULL
 

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;

protected $removal_error = NULL
 

The removal error text if this feature is used after the edition it was removed in.

Generated from protobuf field optional string removal_error = 5;

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