PHPFUI/InstaDoc

A single field of a message type.

New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.

Generated from protobuf message google.protobuf.Field

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

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

@type int $kind
      The field type.
@type int $cardinality
      The field cardinality.
@type int $number
      The field number.
@type string $name
      The field name.
@type string $type_url
      The field type URL, without the scheme, for message or enumeration
      types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
@type int $oneof_index
      The index of the field type in `Type.oneofs`, for message or enumeration
      types. The first type has index 1; zero means the type is not in the list.
@type bool $packed
      Whether to use alternative packed wire representation.
@type \Google\Protobuf\Option[] $options
      The protocol buffer options.
@type string $json_name
      The field JSON name.
@type string $default_value
      The string value of the default value of this field. Proto2 syntax only.

}

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 Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getCardinality()

The field cardinality.

Generated from protobuf field .google.protobuf.Field.Cardinality cardinality = 2;

return int

public getDefaultValue()

The string value of the default value of this field. Proto2 syntax only.

Generated from protobuf field string default_value = 11;

return string

public getJsonName()

The field JSON name.

Generated from protobuf field string json_name = 10;

return string

public getKind()

The field type.

Generated from protobuf field .google.protobuf.Field.Kind kind = 1;

return int

public getName()

The field name.

Generated from protobuf field string name = 4;

return string

public getNumber()

The field number.

Generated from protobuf field int32 number = 3;

return int

public getOneofIndex()

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

Generated from protobuf field int32 oneof_index = 7;

return int

public getOptions()

The protocol buffer options.

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

return \RepeatedField<\Google\Protobuf\Option>

public getPacked()

Whether to use alternative packed wire representation.

Generated from protobuf field bool packed = 8;

return bool

public getTypeUrl()

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

Generated from protobuf field string type_url = 6;

return string

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

The field cardinality.

Generated from protobuf field .google.protobuf.Field.Cardinality cardinality = 2;

param int $var
return $this

public setDefaultValue( $var)

The string value of the default value of this field. Proto2 syntax only.

Generated from protobuf field string default_value = 11;

param string $var
return $this

public setJsonName( $var)

The field JSON name.

Generated from protobuf field string json_name = 10;

param string $var
return $this

public setKind( $var)

The field type.

Generated from protobuf field .google.protobuf.Field.Kind kind = 1;

param int $var
return $this

public setName( $var)

The field name.

Generated from protobuf field string name = 4;

param string $var
return $this

public setNumber( $var)

The field number.

Generated from protobuf field int32 number = 3;

param int $var
return $this

public setOneofIndex( $var)

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

Generated from protobuf field int32 oneof_index = 7;

param int $var
return $this

public setOptions( $var)

The protocol buffer options.

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

param \Google\Protobuf\Option[] $var
return $this

public setPacked( $var)

Whether to use alternative packed wire representation.

Generated from protobuf field bool packed = 8;

param bool $var
return $this

public setTypeUrl( $var)

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

Generated from protobuf field string type_url = 6;

param string $var
return $this

Properties

protected $cardinality = 0

The field cardinality.

Generated from protobuf field .google.protobuf.Field.Cardinality cardinality = 2;

protected $default_value = ''

The string value of the default value of this field. Proto2 syntax only.

Generated from protobuf field string default_value = 11;

protected $json_name = ''

The field JSON name.

Generated from protobuf field string json_name = 10;

protected $kind = 0

The field type.

Generated from protobuf field .google.protobuf.Field.Kind kind = 1;

protected $name = ''

The field name.

Generated from protobuf field string name = 4;

protected $number = 0

The field number.

Generated from protobuf field int32 number = 3;

protected $oneof_index = 0

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

Generated from protobuf field int32 oneof_index = 7;

protected $packed = false

Whether to use alternative packed wire representation.

Generated from protobuf field bool packed = 8;

protected $type_url = ''

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

Generated from protobuf field string type_url = 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 $options = NULL

The protocol buffer options.

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