Generated from protobuf message google.protobuf.MessageOptions

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 

Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::clear()
     

    Clear all containing fields.

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

    Clear all unknown fields previously parsed.

    • return
    public getDeprecated()
     

    Is this message deprecated?
    Depending on the target platform, this can emit Deprecated annotations
    for the message, or it will be completely ignored; in the very least,
    this is a formalization for deprecating messages.

    Generated from protobuf field optional bool deprecated = 3 [default = false];

    • return bool
    public getMapEntry()
     

    Whether the message is an automatically generated map entry type for the
    maps field.

    For maps fields:

    map<KeyType, ValueType> map_field = 1;
    

    The parsed descriptor looks like:

    message MapFieldEntry {
        option map_entry = true;
        optional KeyType key = 1;
        optional ValueType value = 2;
    }
    repeated MapFieldEntry map_field = 1;
    

    Implementations may choose not to generate the map_entry=true message, but
    use a native map in the target language to hold the keys and values.
    The reflection APIs in such implementations still need to work as
    if the field is a repeated message field.
    NOTE: Do not set the option in .proto files. Always use the maps syntax
    instead. The option should only be implicitly set by the proto compiler
    parser.

    Generated from protobuf field optional bool map_entry = 7;

    • return bool
    public getMessageSetWireFormat()
     

    Set true to use the old proto1 MessageSet wire format for extensions.

    This is provided for backwards-compatibility with the MessageSet wire
    format. You should not use this for any other reason: It's less
    efficient, has fewer features, and is more complicated.
    The message must be defined exactly as follows:
    message Foo {

    option message_set_wire_format = true;
    extensions 4 to max;
    

    }
    Note that the message cannot have any defined fields; MessageSets only
    have extensions.
    All extensions of your type must be singular messages; e.g. they cannot
    be int32s, enums, or repeated messages.
    Because this is an option, the above two restrictions are not enforced by
    the protocol compiler.

    Generated from protobuf field optional bool message_set_wire_format = 1 [default = false];

    • return bool
    public getNoStandardDescriptorAccessor()
     

    Disables the generation of the standard "descriptor()" accessor, which can
    conflict with a field of the same name. This is meant to make migration
    from proto1 easier; new code should avoid fields named "descriptor".

    Generated from protobuf field optional bool no_standard_descriptor_accessor = 2 [default = false];

    • return bool
    public getUninterpretedOption()
     

    The parser stores options it doesn't recognize here. See above.

    Generated from protobuf field repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    public hasDeprecated()
    public hasMapEntry()
    public hasMessageSetWireFormat()
    public hasNoStandardDescriptorAccessor()
    public hasUninterpretedOption()
    public Google\Protobuf\Internal\Message::jsonByteSize()
     
    • 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.

    • return
    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.

    • return
    • 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.

    • return
    • 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()
     

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

    Is this message deprecated?
    Depending on the target platform, this can emit Deprecated annotations
    for the message, or it will be completely ignored; in the very least,
    this is a formalization for deprecating messages.

    Generated from protobuf field optional bool deprecated = 3 [default = false];

    • return $this
    public setMapEntry( $var)
     

    Whether the message is an automatically generated map entry type for the
    maps field.

    For maps fields:

    map<KeyType, ValueType> map_field = 1;
    

    The parsed descriptor looks like:

    message MapFieldEntry {
        option map_entry = true;
        optional KeyType key = 1;
        optional ValueType value = 2;
    }
    repeated MapFieldEntry map_field = 1;
    

    Implementations may choose not to generate the map_entry=true message, but
    use a native map in the target language to hold the keys and values.
    The reflection APIs in such implementations still need to work as
    if the field is a repeated message field.
    NOTE: Do not set the option in .proto files. Always use the maps syntax
    instead. The option should only be implicitly set by the proto compiler
    parser.

    Generated from protobuf field optional bool map_entry = 7;

    • return $this
    public setMessageSetWireFormat( $var)
     

    Set true to use the old proto1 MessageSet wire format for extensions.

    This is provided for backwards-compatibility with the MessageSet wire
    format. You should not use this for any other reason: It's less
    efficient, has fewer features, and is more complicated.
    The message must be defined exactly as follows:
    message Foo {

    option message_set_wire_format = true;
    extensions 4 to max;
    

    }
    Note that the message cannot have any defined fields; MessageSets only
    have extensions.
    All extensions of your type must be singular messages; e.g. they cannot
    be int32s, enums, or repeated messages.
    Because this is an option, the above two restrictions are not enforced by
    the protocol compiler.

    Generated from protobuf field optional bool message_set_wire_format = 1 [default = false];

    • return $this
    public setNoStandardDescriptorAccessor( $var)
     

    Disables the generation of the standard "descriptor()" accessor, which can
    conflict with a field of the same name. This is meant to make migration
    from proto1 easier; new code should avoid fields named "descriptor".

    Generated from protobuf field optional bool no_standard_descriptor_accessor = 2 [default = false];

    • return $this
    public setUninterpretedOption( $var)
     

    The parser stores options it doesn't recognize here. See above.

    Generated from protobuf field repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    • return $this
    Properties
    protected $deprecated
     

    Is this message deprecated?
    Depending on the target platform, this can emit Deprecated annotations
    for the message, or it will be completely ignored; in the very least,
    this is a formalization for deprecating messages.

    Generated from protobuf field optional bool deprecated = 3 [default = false];

    protected $map_entry
     

    Whether the message is an automatically generated map entry type for the
    maps field.

    For maps fields:

    map<KeyType, ValueType> map_field = 1;
    

    The parsed descriptor looks like:

    message MapFieldEntry {
        option map_entry = true;
        optional KeyType key = 1;
        optional ValueType value = 2;
    }
    repeated MapFieldEntry map_field = 1;
    

    Implementations may choose not to generate the map_entry=true message, but
    use a native map in the target language to hold the keys and values.
    The reflection APIs in such implementations still need to work as
    if the field is a repeated message field.
    NOTE: Do not set the option in .proto files. Always use the maps syntax
    instead. The option should only be implicitly set by the proto compiler
    parser.

    Generated from protobuf field optional bool map_entry = 7;

    protected $message_set_wire_format
     

    Set true to use the old proto1 MessageSet wire format for extensions.

    This is provided for backwards-compatibility with the MessageSet wire
    format. You should not use this for any other reason: It's less
    efficient, has fewer features, and is more complicated.
    The message must be defined exactly as follows:
    message Foo {

    option message_set_wire_format = true;
    extensions 4 to max;
    

    }
    Note that the message cannot have any defined fields; MessageSets only
    have extensions.
    All extensions of your type must be singular messages; e.g. they cannot
    be int32s, enums, or repeated messages.
    Because this is an option, the above two restrictions are not enforced by
    the protocol compiler.

    Generated from protobuf field optional bool message_set_wire_format = 1 [default = false];

    protected $no_standard_descriptor_accessor
     

    Disables the generation of the standard "descriptor()" accessor, which can
    conflict with a field of the same name. This is meant to make migration
    from proto1 easier; new code should avoid fields named "descriptor".

    Generated from protobuf field optional bool no_standard_descriptor_accessor = 2 [default = false];

    Methods
    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.

    • return
    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 $has_deprecated
    private $has_map_entry
    private $has_message_set_wire_format
    private $has_no_standard_descriptor_accessor
    private $has_uninterpreted_option
    private $uninterpreted_option
     

    The parser stores options it doesn't recognize here. See above.

    Generated from protobuf field repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $ignore_unknown, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     
    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array, $ignore_unknown)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     

    Tries to normalize the elements in $value into a provided protobuf
    wrapper type $class. If $value is any type other than array, we do
    not do any conversion, and instead rely on the existing protobuf
    type checking. If $value is an array, we process each element and
    try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       

      Tries to normalize $value into a provided protobuf wrapper type $class.

      If $value is any type other than an object, we attempt to construct an
      instance of $class and assign $value to it using the setValue method
      shared by all wrapper types.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         
        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         
        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         
        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         

        Tries to normalize the elements in $value into a provided protobuf
        wrapper type $class. If $value is any type other than array, we do
        not do any conversion, and instead rely on the existing protobuf
        type checking. If $value is an array, we process each element and
        try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           

          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             
            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only