PHPFUI/InstaDoc
 
Copied!

Generated from protobuf message google.protobuf.FileOptions

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type string $java_package
      Sets the Java package where classes generated from this .proto will be
      placed.  By default, the proto package is used, but this is often
      inappropriate because proto packages do not normally start with backwards
      domain names.
@type string $java_outer_classname
      Controls the name of the wrapper Java class generated for the .proto file.
      That class will always contain the .proto file's getDescriptor() method as
      well as any top-level extensions defined in the .proto file.
      If java_multiple_files is disabled, then all the other classes from the
      .proto file will be nested inside the single wrapper outer class.
@type bool $java_multiple_files
      If enabled, then the Java code generator will generate a separate .java
      file for each top-level message, enum, and service defined in the .proto
      file.  Thus, these types will *not* be nested inside the wrapper class
      named by java_outer_classname.  However, the wrapper class will still be
      generated to contain the file's getDescriptor() method as well as any
      top-level extensions defined in the file.
@type bool $java_generate_equals_and_hash
      This option does nothing.
@type bool $java_string_check_utf8
      A proto2 file can set this to true to opt in to UTF-8 checking for Java,
      which will throw an exception if invalid UTF-8 is parsed from the wire or
      assigned to a string field.
      TODO: clarify exactly what kinds of field types this option
      applies to, and update these docs accordingly.
      Proto3 files already perform these checks. Setting the option explicitly to
      false has no effect: it cannot be used to opt proto3 files out of UTF-8
      checks.
@type int $optimize_for
@type string $go_package
      Sets the Go package where structs generated from this .proto will be
      placed. If omitted, the Go package will be derived from the following:
        - The basename of the package import path, if provided.
        - Otherwise, the package statement in the .proto file, if present.
        - Otherwise, the basename of the .proto file, without extension.
@type bool $cc_generic_services
      Should generic services be generated in each language?  "Generic" services
      are not specific to any particular RPC system.  They are generated by the
      main code generators in each language (without additional plugins).
      Generic services were the only kind of service generation supported by
      early versions of google.protobuf.
      Generic services are now considered deprecated in favor of using plugins
      that generate code specific to your particular RPC system.  Therefore,
      these default to false.  Old code which depends on generic services should
      explicitly set them to true.
@type bool $java_generic_services
@type bool $py_generic_services
@type bool $deprecated
      Is this file deprecated?
      Depending on the target platform, this can emit Deprecated annotations
      for everything in the file, or it will be completely ignored; in the very
      least, this is a formalization for deprecating files.
@type bool $cc_enable_arenas
      Enables the use of arenas for the proto messages in this file. This applies
      only to generated classes for C++.
@type string $objc_class_prefix
      Sets the objective c class prefix which is prepended to all objective c
      generated classes from this .proto. There is no default.
@type string $csharp_namespace
      Namespace for generated classes; defaults to the package.
@type string $swift_prefix
      By default Swift generators will take the proto package and CamelCase it
      replacing '.' with underscore and use that to prefix the types/symbols
      defined. When this options is provided, they will use this value instead
      to prefix the types/symbols defined.
@type string $php_class_prefix
      Sets the php class prefix which is prepended to all php generated classes
      from this .proto. Default is empty.
@type string $php_namespace
      Use this option to change the namespace of php generated classes. Default
      is empty. When this option is empty, the package name will be used for
      determining the namespace.
@type string $php_metadata_namespace
      Use this option to change the namespace of php generated metadata classes.
      Default is empty. When this option is empty, the proto file name will be
      used for determining the namespace.
@type string $ruby_package
      Use this option to change the package of ruby generated classes. Default
      is empty. When this option is not set, the package name will be used for
      determining the ruby package.
@type \Google\Protobuf\Internal\FeatureSet $features
      Any features defined in the specific edition.
      WARNING: This field should only be used by protobuf plugins or special
      cases like the proto compiler. Other uses are discouraged and
      developers should rely on the protoreflect APIs for their client language.
@type \Google\Protobuf\Internal\UninterpretedOption[] $uninterpreted_option
      The parser stores options it doesn't recognize here.
      See the documentation for the "Options" section above.
    }
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 clearCcEnableArenas()
public clearCcGenericServices()
public clearCsharpNamespace()
public clearDeprecated()
public clearFeatures()
public clearGoPackage()
public clearJavaGenerateEqualsAndHash()
public clearJavaGenericServices()
public clearJavaMultipleFiles()
public clearJavaOuterClassname()
public clearJavaPackage()
public clearJavaStringCheckUtf8()
public clearObjcClassPrefix()
public clearOptimizeFor()
public clearPhpClassPrefix()
public clearPhpMetadataNamespace()
public clearPhpNamespace()
public clearPyGenericServices()
public clearRubyPackage()
public clearSwiftPrefix()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getCcEnableArenas()
 

Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.

Generated from protobuf field optional bool cc_enable_arenas = 31 [default = true];

  • return bool
public getCcGenericServices()
 

Should generic services be generated in each language? "Generic" services are not specific to any particular RPC system. They are generated by the main code generators in each language (without additional plugins).

Generic services were the only kind of service generation supported by early versions of google.protobuf. Generic services are now considered deprecated in favor of using plugins that generate code specific to your particular RPC system. Therefore, these default to false. Old code which depends on generic services should explicitly set them to true.

Generated from protobuf field optional bool cc_generic_services = 16 [default = false];

  • return bool
public getCsharpNamespace()
 

Namespace for generated classes; defaults to the package.

Generated from protobuf field optional string csharp_namespace = 37;

  • return string
public getDeprecated()
 

Is this file deprecated? Depending on the target platform, this can emit Deprecated annotations for everything in the file, or it will be completely ignored; in the very least, this is a formalization for deprecating files.

Generated from protobuf field optional bool deprecated = 23 [default = false];

  • return bool
public getFeatures()
 

Any features defined in the specific edition.

WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

Generated from protobuf field optional .google.protobuf.FeatureSet features = 50;

  • return \Google\Protobuf\Internal\FeatureSet|null
public getGoPackage()
 

Sets the Go package where structs generated from this .proto will be placed. If omitted, the Go package will be derived from the following:

  • The basename of the package import path, if provided.
  • Otherwise, the package statement in the .proto file, if present.
    • Otherwise, the basename of the .proto file, without extension.

Generated from protobuf field optional string go_package = 11;

  • return string
public getJavaGenerateEqualsAndHash()
 

This option does nothing.

Generated from protobuf field optional bool java_generate_equals_and_hash = 20 [deprecated = true];

  • return bool
  • deprecated
public getJavaGenericServices()
 

Generated from protobuf field optional bool java_generic_services = 17 [default = false];

  • return bool
public getJavaMultipleFiles()
 

If enabled, then the Java code generator will generate a separate .java file for each top-level message, enum, and service defined in the .proto file. Thus, these types will not be nested inside the wrapper class named by java_outer_classname. However, the wrapper class will still be generated to contain the file's getDescriptor() method as well as any top-level extensions defined in the file.

Generated from protobuf field optional bool java_multiple_files = 10 [default = false, feature_support = {

  • return bool
public getJavaOuterClassname()
 

Controls the name of the wrapper Java class generated for the .proto file.

That class will always contain the .proto file's getDescriptor() method as well as any top-level extensions defined in the .proto file. If java_multiple_files is disabled, then all the other classes from the .proto file will be nested inside the single wrapper outer class.

Generated from protobuf field optional string java_outer_classname = 8;

  • return string
public getJavaPackage()
 

Sets the Java package where classes generated from this .proto will be placed. By default, the proto package is used, but this is often inappropriate because proto packages do not normally start with backwards domain names.

Generated from protobuf field optional string java_package = 1;

  • return string
public getJavaStringCheckUtf8()
 

A proto2 file can set this to true to opt in to UTF-8 checking for Java, which will throw an exception if invalid UTF-8 is parsed from the wire or assigned to a string field.

TODO: clarify exactly what kinds of field types this option applies to, and update these docs accordingly. Proto3 files already perform these checks. Setting the option explicitly to false has no effect: it cannot be used to opt proto3 files out of UTF-8 checks.

Generated from protobuf field optional bool java_string_check_utf8 = 27 [default = false];

  • return bool
public getObjcClassPrefix()
 

Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.

Generated from protobuf field optional string objc_class_prefix = 36;

  • return string
public getOptimizeFor()
 

Generated from protobuf field optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];

  • return int one of the values in {@see \Google\Protobuf\Internal\FileOptions\OptimizeMode}
public getPhpClassPrefix()
 

Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.

Generated from protobuf field optional string php_class_prefix = 40;

  • return string
public getPhpMetadataNamespace()
 

Use this option to change the namespace of php generated metadata classes.

Default is empty. When this option is empty, the proto file name will be used for determining the namespace.

Generated from protobuf field optional string php_metadata_namespace = 44;

  • return string
public getPhpNamespace()
 

Use this option to change the namespace of php generated classes. Default is empty. When this option is empty, the package name will be used for determining the namespace.

Generated from protobuf field optional string php_namespace = 41;

  • return string
public getPyGenericServices()
 

Generated from protobuf field optional bool py_generic_services = 18 [default = false];

  • return bool
public getRubyPackage()
 

Use this option to change the package of ruby generated classes. Default is empty. When this option is not set, the package name will be used for determining the ruby package.

Generated from protobuf field optional string ruby_package = 45;

  • return string
public getSwiftPrefix()
 

By default Swift generators will take the proto package and CamelCase it replacing '.' with underscore and use that to prefix the types/symbols defined. When this options is provided, they will use this value instead to prefix the types/symbols defined.

Generated from protobuf field optional string swift_prefix = 39;

  • return string
public getUninterpretedOption()
 

The parser stores options it doesn't recognize here.

See the documentation for the "Options" section above.

Generated from protobuf field repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

  • return \RepeatedField<\Google\Protobuf\Internal\UninterpretedOption>
public hasCcEnableArenas()
public hasCcGenericServices()
public hasCsharpNamespace()
public hasDeprecated()
public hasFeatures()
public hasGoPackage()
public hasJavaGenerateEqualsAndHash()
public hasJavaGenericServices()
public hasJavaMultipleFiles()
public hasJavaOuterClassname()
public hasJavaPackage()
public hasJavaStringCheckUtf8()
public hasObjcClassPrefix()
public hasOptimizeFor()
public hasPhpClassPrefix()
public hasPhpMetadataNamespace()
public hasPhpNamespace()
public hasPyGenericServices()
public hasRubyPackage()
public hasSwiftPrefix()
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 setCcEnableArenas(bool $var)
 

Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.

Generated from protobuf field optional bool cc_enable_arenas = 31 [default = true];

  • param bool $var
  • return $this
public setCcGenericServices(bool $var)
 

Should generic services be generated in each language? "Generic" services are not specific to any particular RPC system. They are generated by the main code generators in each language (without additional plugins).

Generic services were the only kind of service generation supported by early versions of google.protobuf. Generic services are now considered deprecated in favor of using plugins that generate code specific to your particular RPC system. Therefore, these default to false. Old code which depends on generic services should explicitly set them to true.

Generated from protobuf field optional bool cc_generic_services = 16 [default = false];

  • param bool $var
  • return $this
public setCsharpNamespace(string $var)
 

Namespace for generated classes; defaults to the package.

Generated from protobuf field optional string csharp_namespace = 37;

  • param string $var
  • return $this
public setDeprecated(bool $var)
 

Is this file deprecated? Depending on the target platform, this can emit Deprecated annotations for everything in the file, or it will be completely ignored; in the very least, this is a formalization for deprecating files.

Generated from protobuf field optional bool deprecated = 23 [default = false];

  • param bool $var
  • return $this
public setFeatures(?Google\Protobuf\Internal\FeatureSet $var)
 

Any features defined in the specific edition.

WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

Generated from protobuf field optional .google.protobuf.FeatureSet features = 50;

  • param \Google\Protobuf\Internal\FeatureSet $var
  • return $this
public setGoPackage(string $var)
 

Sets the Go package where structs generated from this .proto will be placed. If omitted, the Go package will be derived from the following:

  • The basename of the package import path, if provided.
  • Otherwise, the package statement in the .proto file, if present.
    • Otherwise, the basename of the .proto file, without extension.

Generated from protobuf field optional string go_package = 11;

  • param string $var
  • return $this
public setJavaGenerateEqualsAndHash(bool $var)
 

This option does nothing.

Generated from protobuf field optional bool java_generate_equals_and_hash = 20 [deprecated = true];

  • param bool $var
  • return $this
  • deprecated
public setJavaGenericServices(bool $var)
 

Generated from protobuf field optional bool java_generic_services = 17 [default = false];

  • param bool $var
  • return $this
public setJavaMultipleFiles(bool $var)
 

If enabled, then the Java code generator will generate a separate .java file for each top-level message, enum, and service defined in the .proto file. Thus, these types will not be nested inside the wrapper class named by java_outer_classname. However, the wrapper class will still be generated to contain the file's getDescriptor() method as well as any top-level extensions defined in the file.

Generated from protobuf field optional bool java_multiple_files = 10 [default = false, feature_support = {

  • param bool $var
  • return $this
public setJavaOuterClassname(string $var)
 

Controls the name of the wrapper Java class generated for the .proto file.

That class will always contain the .proto file's getDescriptor() method as well as any top-level extensions defined in the .proto file. If java_multiple_files is disabled, then all the other classes from the .proto file will be nested inside the single wrapper outer class.

Generated from protobuf field optional string java_outer_classname = 8;

  • param string $var
  • return $this
public setJavaPackage(string $var)
 

Sets the Java package where classes generated from this .proto will be placed. By default, the proto package is used, but this is often inappropriate because proto packages do not normally start with backwards domain names.

Generated from protobuf field optional string java_package = 1;

  • param string $var
  • return $this
public setJavaStringCheckUtf8(bool $var)
 

A proto2 file can set this to true to opt in to UTF-8 checking for Java, which will throw an exception if invalid UTF-8 is parsed from the wire or assigned to a string field.

TODO: clarify exactly what kinds of field types this option applies to, and update these docs accordingly. Proto3 files already perform these checks. Setting the option explicitly to false has no effect: it cannot be used to opt proto3 files out of UTF-8 checks.

Generated from protobuf field optional bool java_string_check_utf8 = 27 [default = false];

  • param bool $var
  • return $this
public setObjcClassPrefix(string $var)
 

Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.

Generated from protobuf field optional string objc_class_prefix = 36;

  • param string $var
  • return $this
public setOptimizeFor(int $var)
 

Generated from protobuf field optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];

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

Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.

Generated from protobuf field optional string php_class_prefix = 40;

  • param string $var
  • return $this
public setPhpMetadataNamespace(string $var)
 

Use this option to change the namespace of php generated metadata classes.

Default is empty. When this option is empty, the proto file name will be used for determining the namespace.

Generated from protobuf field optional string php_metadata_namespace = 44;

  • param string $var
  • return $this
public setPhpNamespace(string $var)
 

Use this option to change the namespace of php generated classes. Default is empty. When this option is empty, the package name will be used for determining the namespace.

Generated from protobuf field optional string php_namespace = 41;

  • param string $var
  • return $this
public setPyGenericServices(bool $var)
 

Generated from protobuf field optional bool py_generic_services = 18 [default = false];

  • param bool $var
  • return $this
public setRubyPackage(string $var)
 

Use this option to change the package of ruby generated classes. Default is empty. When this option is not set, the package name will be used for determining the ruby package.

Generated from protobuf field optional string ruby_package = 45;

  • param string $var
  • return $this
public setSwiftPrefix(string $var)
 

By default Swift generators will take the proto package and CamelCase it replacing '.' with underscore and use that to prefix the types/symbols defined. When this options is provided, they will use this value instead to prefix the types/symbols defined.

Generated from protobuf field optional string swift_prefix = 39;

  • param string $var
  • return $this
public setUninterpretedOption(Google\Protobuf\RepeatedField|array $var)
 

The parser stores options it doesn't recognize here.

See the documentation for the "Options" section above.

Generated from protobuf field repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

  • param \Google\Protobuf\Internal\UninterpretedOption[] $var
  • return $this
Properties
protected $cc_enable_arenas = NULL
 

Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.

Generated from protobuf field optional bool cc_enable_arenas = 31 [default = true];

protected $cc_generic_services = NULL
 

Should generic services be generated in each language? "Generic" services are not specific to any particular RPC system. They are generated by the main code generators in each language (without additional plugins).

Generic services were the only kind of service generation supported by early versions of google.protobuf. Generic services are now considered deprecated in favor of using plugins that generate code specific to your particular RPC system. Therefore, these default to false. Old code which depends on generic services should explicitly set them to true.

Generated from protobuf field optional bool cc_generic_services = 16 [default = false];

protected $csharp_namespace = NULL
 

Namespace for generated classes; defaults to the package.

Generated from protobuf field optional string csharp_namespace = 37;

protected $deprecated = NULL
 

Is this file deprecated? Depending on the target platform, this can emit Deprecated annotations for everything in the file, or it will be completely ignored; in the very least, this is a formalization for deprecating files.

Generated from protobuf field optional bool deprecated = 23 [default = false];

protected $features = NULL
 

Any features defined in the specific edition.

WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

Generated from protobuf field optional .google.protobuf.FeatureSet features = 50;

protected $go_package = NULL
 

Sets the Go package where structs generated from this .proto will be placed. If omitted, the Go package will be derived from the following:

  • The basename of the package import path, if provided.
  • Otherwise, the package statement in the .proto file, if present.
    • Otherwise, the basename of the .proto file, without extension.

Generated from protobuf field optional string go_package = 11;

protected $java_generate_equals_and_hash = NULL
 

This option does nothing.

Generated from protobuf field optional bool java_generate_equals_and_hash = 20 [deprecated = true];

  • deprecated
protected $java_generic_services = NULL
 

Generated from protobuf field optional bool java_generic_services = 17 [default = false];

protected $java_multiple_files = NULL
 

If enabled, then the Java code generator will generate a separate .java file for each top-level message, enum, and service defined in the .proto file. Thus, these types will not be nested inside the wrapper class named by java_outer_classname. However, the wrapper class will still be generated to contain the file's getDescriptor() method as well as any top-level extensions defined in the file.

Generated from protobuf field optional bool java_multiple_files = 10 [default = false, feature_support = {

protected $java_outer_classname = NULL
 

Controls the name of the wrapper Java class generated for the .proto file.

That class will always contain the .proto file's getDescriptor() method as well as any top-level extensions defined in the .proto file. If java_multiple_files is disabled, then all the other classes from the .proto file will be nested inside the single wrapper outer class.

Generated from protobuf field optional string java_outer_classname = 8;

protected $java_package = NULL
 

Sets the Java package where classes generated from this .proto will be placed. By default, the proto package is used, but this is often inappropriate because proto packages do not normally start with backwards domain names.

Generated from protobuf field optional string java_package = 1;

protected $java_string_check_utf8 = NULL
 

A proto2 file can set this to true to opt in to UTF-8 checking for Java, which will throw an exception if invalid UTF-8 is parsed from the wire or assigned to a string field.

TODO: clarify exactly what kinds of field types this option applies to, and update these docs accordingly. Proto3 files already perform these checks. Setting the option explicitly to false has no effect: it cannot be used to opt proto3 files out of UTF-8 checks.

Generated from protobuf field optional bool java_string_check_utf8 = 27 [default = false];

protected $objc_class_prefix = NULL
 

Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.

Generated from protobuf field optional string objc_class_prefix = 36;

protected $optimize_for = NULL
 

Generated from protobuf field optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9 [default = SPEED];

protected $php_class_prefix = NULL
 

Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.

Generated from protobuf field optional string php_class_prefix = 40;

protected $php_metadata_namespace = NULL
 

Use this option to change the namespace of php generated metadata classes.

Default is empty. When this option is empty, the proto file name will be used for determining the namespace.

Generated from protobuf field optional string php_metadata_namespace = 44;

protected $php_namespace = NULL
 

Use this option to change the namespace of php generated classes. Default is empty. When this option is empty, the package name will be used for determining the namespace.

Generated from protobuf field optional string php_namespace = 41;

protected $py_generic_services = NULL
 

Generated from protobuf field optional bool py_generic_services = 18 [default = false];

protected $ruby_package = NULL
 

Use this option to change the package of ruby generated classes. Default is empty. When this option is not set, the package name will be used for determining the ruby package.

Generated from protobuf field optional string ruby_package = 45;

protected $swift_prefix = NULL
 

By default Swift generators will take the proto package and CamelCase it replacing '.' with underscore and use that to prefix the types/symbols defined. When this options is provided, they will use this value instead to prefix the types/symbols defined.

Generated from protobuf field optional string swift_prefix = 39;

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)
Properties
private $uninterpreted_option = NULL
 

The parser stores options it doesn't recognize here.

See the documentation for the "Options" section above.

Generated from protobuf field repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration