PHPFUI/InstaDoc

Generated from protobuf message google.protobuf.ExtensionRangeOptions.Declaration

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Public
Protected

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type int $number
      The extension number declared within the extension range.
@type string $full_name
      The fully-qualified name of the extension field. There must be a leading
      dot in front of the full name.
@type string $type
      The fully-qualified type name of the extension field. Unlike
      Metadata.type, Declaration.type must have a leading dot for messages
      and enums.
@type bool $reserved
      If true, indicates that the number is reserved in the extension range,
      and any extension field with the number will fail to compile. Set this
      when a declared extension field is deleted.
@type bool $repeated
      If true, indicates that the extension must be defined as repeated.
      Otherwise the extension must be defined as optional.

}

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 clearFullName()

public clearNumber()

public clearRepeated()

public clearReserved()

public clearType()

public Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getFullName()

The fully-qualified name of the extension field. There must be a leading dot in front of the full name.

Generated from protobuf field optional string full_name = 2;

return string

public getNumber()

The extension number declared within the extension range.

Generated from protobuf field optional int32 number = 1;

return int

public getRepeated()

If true, indicates that the extension must be defined as repeated.

Otherwise the extension must be defined as optional.

Generated from protobuf field optional bool repeated = 6;

return bool

public getReserved()

If true, indicates that the number is reserved in the extension range, and any extension field with the number will fail to compile. Set this when a declared extension field is deleted.

Generated from protobuf field optional bool reserved = 5;

return bool

public getType()

The fully-qualified type name of the extension field. Unlike Metadata.type, Declaration.type must have a leading dot for messages and enums.

Generated from protobuf field optional string type = 3;

return string

public hasFullName()

public hasNumber()

public hasRepeated()

public hasReserved()

public hasType()

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 setFullName( $var)

The fully-qualified name of the extension field. There must be a leading dot in front of the full name.

Generated from protobuf field optional string full_name = 2;

param string $var
return $this

public setNumber( $var)

The extension number declared within the extension range.

Generated from protobuf field optional int32 number = 1;

param int $var
return $this

public setRepeated( $var)

If true, indicates that the extension must be defined as repeated.

Otherwise the extension must be defined as optional.

Generated from protobuf field optional bool repeated = 6;

param bool $var
return $this

public setReserved( $var)

If true, indicates that the number is reserved in the extension range, and any extension field with the number will fail to compile. Set this when a declared extension field is deleted.

Generated from protobuf field optional bool reserved = 5;

param bool $var
return $this

public setType( $var)

The fully-qualified type name of the extension field. Unlike Metadata.type, Declaration.type must have a leading dot for messages and enums.

Generated from protobuf field optional string type = 3;

param string $var
return $this

Properties

protected $full_name = NULL

The fully-qualified name of the extension field. There must be a leading dot in front of the full name.

Generated from protobuf field optional string full_name = 2;

protected $number = NULL

The extension number declared within the extension range.

Generated from protobuf field optional int32 number = 1;

protected $repeated = NULL

If true, indicates that the extension must be defined as repeated.

Otherwise the extension must be defined as optional.

Generated from protobuf field optional bool repeated = 6;

protected $reserved = NULL

If true, indicates that the number is reserved in the extension range, and any extension field with the number will fail to compile. Set this when a declared extension field is deleted.

Generated from protobuf field optional bool reserved = 5;

protected $type = NULL

The fully-qualified type name of the extension field. Unlike Metadata.type, Declaration.type must have a leading dot for messages and enums.

Generated from protobuf field optional string type = 3;

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)