Declaration
class Declaration extends Message (View source)
Generated from protobuf message google.protobuf.ExtensionRangeOptions.Declaration
Properties
| protected | $number | The extension number declared within the extension range. |
|
| protected | $full_name | The fully-qualified name of the extension field. There must be a leading dot in front of the full name. |
|
| protected | $type | The fully-qualified type name of the extension field. Unlike Metadata.type, Declaration.type must have a leading dot for messages and enums. |
|
| protected | $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. |
|
| protected | $repeated | If true, indicates that the extension must be defined as repeated. |
Methods
Constructor.
Merges the contents of the specified message into current message.
Parses a json string to protobuf message.
Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.
The extension number declared within the extension range.
No description
No description
The extension number declared within the extension range.
The fully-qualified name of the extension field. There must be a leading dot in front of the full name.
No description
No description
The fully-qualified name of the extension field. There must be a leading dot in front of the full name.
The fully-qualified type name of the extension field. Unlike Metadata.type, Declaration.type must have a leading dot for messages and enums.
No description
No description
The fully-qualified type name of the extension field. Unlike Metadata.type, Declaration.type must have a leading dot for messages and enums.
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.
No description
No description
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.
If true, indicates that the extension must be defined as repeated.
No description
No description
If true, indicates that the extension must be defined as repeated.
Details
__construct($data = NULL)
Constructor.
protected
readWrapperValue($member)
No description
protected
writeWrapperValue($member, $value)
No description
protected
readOneof($number)
No description
protected
hasOneof($number)
No description
protected
writeOneof($number, $value)
No description
protected
whichOneof($oneof_name)
No description
null
clear()
Clear all containing fields.
null
discardUnknownFields()
Clear all unknown fields previously parsed.
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.
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.
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.
parseFromStream($input)
No description
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.
protected
mergeFromJsonArray($array, $ignore_unknown)
No description
parseFromJsonStream($input, $ignore_unknown)
No description
serializeToStream($output)
No description
serializeToJsonStream($output)
No description
string
serializeToString()
Serialize the message to string.
string
serializeToJsonString($options = 0)
Serialize the message to json string.
byteSize()
No description
jsonByteSize($options = 0)
No description
__debugInfo()
No description
int
getNumber()
The extension number declared within the extension range.
Generated from protobuf field optional int32 number = 1;
hasNumber()
No description
clearNumber()
No description
$this
setNumber(int $var)
The extension number declared within the extension range.
Generated from protobuf field optional int32 number = 1;
string
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;
hasFullName()
No description
clearFullName()
No description
$this
setFullName(string $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;
string
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;
hasType()
No description
clearType()
No description
$this
setType(string $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;
bool
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;
hasReserved()
No description
clearReserved()
No description
$this
setReserved(bool $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;
bool
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;
hasRepeated()
No description
clearRepeated()
No description
$this
setRepeated(bool $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;