1. class
  2. Google
  3. \
  4. Protobuf
  5. \
  6. Internal
  7. \
  8. DescriptorProto

DescriptorProto

class DescriptorProto extends Message (View source)

Describes a message type.

Generated from protobuf message google.protobuf.DescriptorProto

Properties

protected $name

Generated from protobuf field optional string name = 1;
protected $options

Generated from protobuf field optional .google.protobuf.MessageOptions options = 7;
protected $visibility

Support for export and local keywords on enums.

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

Generated from protobuf field optional string name = 1;

hasName()

No description

clearName()

No description

$this
setName(string $var)

Generated from protobuf field optional string name = 1;

FieldDescriptorProto>
getField()

Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto field = 2;

$this
setField(FieldDescriptorProto[] $var)

Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto field = 2;

FieldDescriptorProto>
getExtension()

Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 6;

$this
setExtension(FieldDescriptorProto[] $var)

Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 6;

DescriptorProto>
getNestedType()

Generated from protobuf field repeated .google.protobuf.DescriptorProto nested_type = 3;

$this
setNestedType(DescriptorProto[] $var)

Generated from protobuf field repeated .google.protobuf.DescriptorProto nested_type = 3;

EnumDescriptorProto>
getEnumType()

Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 4;

$this
setEnumType(EnumDescriptorProto[] $var)

Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 4;

ExtensionRange>
getExtensionRange()

Generated from protobuf field repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;

$this
setExtensionRange(ExtensionRange[] $var)

Generated from protobuf field repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;

OneofDescriptorProto>
getOneofDecl()

Generated from protobuf field repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;

$this
setOneofDecl(OneofDescriptorProto[] $var)

Generated from protobuf field repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;

MessageOptions|null
getOptions()

Generated from protobuf field optional .google.protobuf.MessageOptions options = 7;

hasOptions()

No description

clearOptions()

No description

$this
setOptions(MessageOptions $var)

Generated from protobuf field optional .google.protobuf.MessageOptions options = 7;

ReservedRange>
getReservedRange()

Generated from protobuf field repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;

$this
setReservedRange(ReservedRange[] $var)

Generated from protobuf field repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;

RepeatedField<string>
getReservedName()

Reserved field names, which may not be used by fields in the same message.

$this
setReservedName(string[] $var)

Reserved field names, which may not be used by fields in the same message.

int
getVisibility()

Support for export and local keywords on enums.

hasVisibility()

No description

clearVisibility()

No description

$this
setVisibility(int $var)

Support for export and local keywords on enums.

Details

at line 93
__construct($data = NULL)

Constructor.

Parameters

$data

in Message at line 158
protected readWrapperValue($member)

No description

Parameters

$member

in Message at line 175
protected writeWrapperValue($member, $value)

No description

Parameters

$member
$value

in Message at line 194
protected readOneof($number)

No description

Parameters

$number

in Message at line 207
protected hasOneof($number)

No description

Parameters

$number

in Message at line 216
protected writeOneof($number, $value)

No description

Parameters

$number
$value

in Message at line 231
protected whichOneof($oneof_name)

No description

Parameters

$oneof_name

in Message at line 527
null clear()

Clear all containing fields.

Return Value

null

in Message at line 637
null discardUnknownFields()

Clear all unknown fields previously parsed.

Return Value

null

in Message at line 683
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

in Message at line 751
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

in Message at line 770
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

in Message at line 779
parseFromStream($input)

No description

Parameters

$input

in Message at line 1037
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

in Message at line 1126
protected mergeFromJsonArray($array, $ignore_unknown)

No description

Parameters

$array
$ignore_unknown

in Message at line 1322
parseFromJsonStream($input, $ignore_unknown)

No description

Parameters

$input
$ignore_unknown

in Message at line 1455
serializeToStream($output)

No description

Parameters

$output

in Message at line 1470
serializeToJsonStream($output)

No description

Parameters

$output

in Message at line 1562
string serializeToString()

Serialize the message to string.

Return Value

string

Serialized binary protobuf data.

in Message at line 1573
string serializeToJsonString($options = 0)

Serialize the message to json string.

Parameters

$options

Return Value

string

Serialized json protobuf data.

in Message at line 1941
byteSize()

No description

in Message at line 1982
jsonByteSize($options = 0)

No description

Parameters

$options

in Message at line 2057
__debugInfo()

No description

at line 102
string getName()

Generated from protobuf field optional string name = 1;

Return Value

string

at line 107
hasName()

No description

at line 112
clearName()

No description

at line 122
$this setName(string $var)

Generated from protobuf field optional string name = 1;

Parameters

string $var

Return Value

$this

at line 134
FieldDescriptorProto> getField()

Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto field = 2;

Return Value

FieldDescriptorProto>

at line 144
$this setField(FieldDescriptorProto[] $var)

Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto field = 2;

Parameters

FieldDescriptorProto[] $var

Return Value

$this

at line 156
FieldDescriptorProto> getExtension()

Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 6;

Return Value

FieldDescriptorProto>

at line 166
$this setExtension(FieldDescriptorProto[] $var)

Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 6;

Parameters

FieldDescriptorProto[] $var

Return Value

$this

at line 178
DescriptorProto> getNestedType()

Generated from protobuf field repeated .google.protobuf.DescriptorProto nested_type = 3;

Return Value

DescriptorProto>

at line 188
$this setNestedType(DescriptorProto[] $var)

Generated from protobuf field repeated .google.protobuf.DescriptorProto nested_type = 3;

Parameters

DescriptorProto[] $var

Return Value

$this

at line 200
EnumDescriptorProto> getEnumType()

Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 4;

Return Value

EnumDescriptorProto>

at line 210
$this setEnumType(EnumDescriptorProto[] $var)

Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 4;

Parameters

EnumDescriptorProto[] $var

Return Value

$this

at line 222
ExtensionRange> getExtensionRange()

Generated from protobuf field repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;

Return Value

ExtensionRange>

at line 232
$this setExtensionRange(ExtensionRange[] $var)

Generated from protobuf field repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;

Parameters

ExtensionRange[] $var

Return Value

$this

at line 244
OneofDescriptorProto> getOneofDecl()

Generated from protobuf field repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;

Return Value

OneofDescriptorProto>

at line 254
$this setOneofDecl(OneofDescriptorProto[] $var)

Generated from protobuf field repeated .google.protobuf.OneofDescriptorProto oneof_decl = 8;

Parameters

OneofDescriptorProto[] $var

Return Value

$this

at line 266
MessageOptions|null getOptions()

Generated from protobuf field optional .google.protobuf.MessageOptions options = 7;

Return Value

MessageOptions|null

at line 271
hasOptions()

No description

at line 276
clearOptions()

No description

at line 286
$this setOptions(MessageOptions $var)

Generated from protobuf field optional .google.protobuf.MessageOptions options = 7;

Parameters

MessageOptions $var

Return Value

$this

at line 298
ReservedRange> getReservedRange()

Generated from protobuf field repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;

Return Value

ReservedRange>

at line 308
$this setReservedRange(ReservedRange[] $var)

Generated from protobuf field repeated .google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;

Parameters

ReservedRange[] $var

Return Value

$this

at line 323
RepeatedField<string> getReservedName()

Reserved field names, which may not be used by fields in the same message.

A given name may only be reserved once.

Generated from protobuf field repeated string reserved_name = 10;

Return Value

RepeatedField<string>

at line 336
$this setReservedName(string[] $var)

Reserved field names, which may not be used by fields in the same message.

A given name may only be reserved once.

Generated from protobuf field repeated string reserved_name = 10;

Parameters

string[] $var

Return Value

$this

at line 350
int getVisibility()

Support for export and local keywords on enums.

Generated from protobuf field optional .google.protobuf.SymbolVisibility visibility = 11;

Return Value

int

at line 355
hasVisibility()

No description

at line 360
clearVisibility()

No description

at line 372
$this setVisibility(int $var)

Support for export and local keywords on enums.

Generated from protobuf field optional .google.protobuf.SymbolVisibility visibility = 11;

Parameters

int $var

Return Value

$this