PHPFUI/InstaDoc
 
Copied!

Describes an enum type.

Generated from protobuf message google.protobuf.EnumDescriptorProto

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type string $name
@type \Google\Protobuf\Internal\EnumValueDescriptorProto[] $value
@type \Google\Protobuf\Internal\EnumOptions $options
@type \Google\Protobuf\Internal\EnumDescriptorProto\EnumReservedRange[] $reserved_range
      Range of reserved numeric values. Reserved numeric values may not be used
      by enum values in the same enum declaration. Reserved ranges may not
      overlap.
@type string[] $reserved_name
      Reserved enum value names, which may not be reused. A given name may only
      be reserved once.
@type int $visibility
      Support for `export` and `local` keywords on enums.
    }
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 clearName()
public clearOptions()
public clearVisibility()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getName()
 

Generated from protobuf field optional string name = 1;

  • return string
public getOptions()
 

Generated from protobuf field optional .google.protobuf.EnumOptions options = 3;

  • return \Google\Protobuf\Internal\EnumOptions|null
public getReservedName()
 

Reserved enum value names, which may not be reused. A given name may only be reserved once.

Generated from protobuf field repeated string reserved_name = 5;

  • return \RepeatedField<string>
public getReservedRange()
 

Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap.

Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto.EnumReservedRange reserved_range = 4;

  • return \RepeatedField<\Google\Protobuf\Internal\EnumDescriptorProto\EnumReservedRange>
public getValue()
 

Generated from protobuf field repeated .google.protobuf.EnumValueDescriptorProto value = 2;

  • return \RepeatedField<\Google\Protobuf\Internal\EnumValueDescriptorProto>
public getVisibility()
 

Support for export and local keywords on enums.

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

  • return int
public hasName()
public hasOptions()
public hasVisibility()
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 setName( $var)
 

Generated from protobuf field optional string name = 1;

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

Generated from protobuf field optional .google.protobuf.EnumOptions options = 3;

  • param \Google\Protobuf\Internal\EnumOptions $var
  • return $this
public setReservedName( $var)
 

Reserved enum value names, which may not be reused. A given name may only be reserved once.

Generated from protobuf field repeated string reserved_name = 5;

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

Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap.

Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto.EnumReservedRange reserved_range = 4;

  • param \Google\Protobuf\Internal\EnumDescriptorProto\EnumReservedRange[] $var
  • return $this
public setValue( $var)
 

Generated from protobuf field repeated .google.protobuf.EnumValueDescriptorProto value = 2;

  • param \Google\Protobuf\Internal\EnumValueDescriptorProto[] $var
  • return $this
public setVisibility( $var)
 

Support for export and local keywords on enums.

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

  • param int $var
  • return $this
Properties
protected $name = NULL
 

Generated from protobuf field optional string name = 1;

protected $options = NULL
 

Generated from protobuf field optional .google.protobuf.EnumOptions options = 3;

protected $visibility = NULL
 

Support for export and local keywords on enums.

Generated from protobuf field optional .google.protobuf.SymbolVisibility visibility = 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 $reserved_name = NULL
 

Reserved enum value names, which may not be reused. A given name may only be reserved once.

Generated from protobuf field repeated string reserved_name = 5;

private $reserved_range = NULL
 

Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap.

Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto.EnumReservedRange reserved_range = 4;

private $value = NULL
 

Generated from protobuf field repeated .google.protobuf.EnumValueDescriptorProto value = 2;

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration