PHPFUI/InstaDoc
 
Copied!

A protocol buffer message type.

Generated from protobuf message google.protobuf.Type

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type string $name
      The fully qualified message name.
@type \Google\Protobuf\Field[] $fields
      The list of fields.
@type string[] $oneofs
      The list of types appearing in `oneof` definitions in this type.
@type \Google\Protobuf\Option[] $options
      The protocol buffer options.
@type \Google\Protobuf\SourceContext $source_context
      The source context.
@type int $syntax
      The source syntax.
@type string $edition
      The source edition string, only valid when syntax is SYNTAX_EDITIONS.
    }
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 clearSourceContext()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getEdition()
 

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

Generated from protobuf field string edition = 7;

  • return string
public getFields()
 

The list of fields.

Generated from protobuf field repeated .google.protobuf.Field fields = 2;

  • return \RepeatedField<\Google\Protobuf\Field>
public getName()
 

The fully qualified message name.

Generated from protobuf field string name = 1;

  • return string
public getOneofs()
 

The list of types appearing in oneof definitions in this type.

Generated from protobuf field repeated string oneofs = 3;

  • return \RepeatedField<string>
public getOptions()
 

The protocol buffer options.

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

  • return \RepeatedField<\Google\Protobuf\Option>
public getSourceContext()
 

The source context.

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

  • return \Google\Protobuf\SourceContext|null
public getSyntax()
 

The source syntax.

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

  • return int
public hasSourceContext()
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 setEdition( $var)
 

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

Generated from protobuf field string edition = 7;

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

The list of fields.

Generated from protobuf field repeated .google.protobuf.Field fields = 2;

  • param \Google\Protobuf\Field[] $var
  • return $this
public setName( $var)
 

The fully qualified message name.

Generated from protobuf field string name = 1;

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

The list of types appearing in oneof definitions in this type.

Generated from protobuf field repeated string oneofs = 3;

  • param string[] $var
  • return $this
public setOptions( $var)
 

The protocol buffer options.

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

  • param \Google\Protobuf\Option[] $var
  • return $this
public setSourceContext( $var)
 

The source context.

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

  • param \Google\Protobuf\SourceContext $var
  • return $this
public setSyntax( $var)
 

The source syntax.

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

  • param int $var
  • return $this
Properties
protected $edition = ''
 

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

Generated from protobuf field string edition = 7;

protected $name = ''
 

The fully qualified message name.

Generated from protobuf field string name = 1;

protected $source_context = NULL
 

The source context.

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

protected $syntax = 0
 

The source syntax.

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

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 $fields = NULL
 

The list of fields.

Generated from protobuf field repeated .google.protobuf.Field fields = 2;

private $oneofs = NULL
 

The list of types appearing in oneof definitions in this type.

Generated from protobuf field repeated string oneofs = 3;

private $options = NULL
 

The protocol buffer options.

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

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration