Generated from protobuf message google.protobuf.FieldOptions

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

    The ctype option instructs the C++ code generator to use a different
    representation of the field than it normally would. See the specific
    options below. This option is not yet implemented in the open source
    release -- sorry, we'll try to include it in a future version!

    Generated from protobuf field optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];

    • return int
    public getDeprecated()
     

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

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

    • return bool
    public getJstype()
     

    The jstype option determines the JavaScript type used for values of the
    field. The option is permitted only for 64 bit integral and fixed types
    (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING
    is represented as JavaScript string, which avoids loss of precision that
    can happen when a large value is converted to a floating point JavaScript.

    Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
    use the JavaScript "number" type. The behavior of the default option
    JS_NORMAL is implementation dependent.
    This option is an enum to permit additional types to be added, e.g.
    goog.math.Integer.

    Generated from protobuf field optional .google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL];

    • return int
    public getLazy()
     

    Should this field be parsed lazily? Lazy applies only to message-type
    fields. It means that when the outer message is initially parsed, the
    inner message's contents will not be parsed but instead stored in encoded
    form. The inner message will actually be parsed when it is first accessed.

    This is only a hint. Implementations are free to choose whether to use
    eager or lazy parsing regardless of the value of this option. However,
    setting this option true suggests that the protocol author believes that
    using lazy parsing on this field is worth the additional bookkeeping
    overhead typically needed to implement it.
    This option does not affect the public interface of any generated code;
    all method signatures remain the same. Furthermore, thread-safety of the
    interface is not affected by this option; const methods remain safe to
    call from multiple threads concurrently, while non-const methods continue
    to require exclusive access.
    Note that implementations may choose not to check required fields within
    a lazy sub-message. That is, calling IsInitialized() on the outer message
    may return true even if the inner message has missing required fields.
    This is necessary because otherwise the inner message would have to be
    parsed in order to perform the check, defeating the purpose of lazy
    parsing. An implementation which chooses not to check required fields
    must be consistent about it. That is, for any particular sub-message, the
    implementation must either always check its required fields, or never
    check its required fields, regardless of whether or not the message has
    been parsed.

    Generated from protobuf field optional bool lazy = 5 [default = false];

    • return bool
    public getPacked()
     

    The packed option can be enabled for repeated primitive fields to enable
    a more efficient representation on the wire. Rather than repeatedly
    writing the tag and type for each element, the entire array is encoded as
    a single length-delimited blob. In proto3, only explicit setting it to
    false will avoid using packed encoding.

    Generated from protobuf field optional bool packed = 2;

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

    For Google-internal migration only. Do not use.

    Generated from protobuf field optional bool weak = 10 [default = false];

    • return bool
    public hasCtype()
    public hasDeprecated()
    public hasJstype()
    public hasLazy()
    public hasPacked()
    public hasUninterpretedOption()
    public hasWeak()
    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 setCtype( $var)
     

    The ctype option instructs the C++ code generator to use a different
    representation of the field than it normally would. See the specific
    options below. This option is not yet implemented in the open source
    release -- sorry, we'll try to include it in a future version!

    Generated from protobuf field optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];

    • return $this
    public setDeprecated( $var)
     

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

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

    • return $this
    public setJstype( $var)
     

    The jstype option determines the JavaScript type used for values of the
    field. The option is permitted only for 64 bit integral and fixed types
    (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING
    is represented as JavaScript string, which avoids loss of precision that
    can happen when a large value is converted to a floating point JavaScript.

    Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
    use the JavaScript "number" type. The behavior of the default option
    JS_NORMAL is implementation dependent.
    This option is an enum to permit additional types to be added, e.g.
    goog.math.Integer.

    Generated from protobuf field optional .google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL];

    • return $this
    public setLazy( $var)
     

    Should this field be parsed lazily? Lazy applies only to message-type
    fields. It means that when the outer message is initially parsed, the
    inner message's contents will not be parsed but instead stored in encoded
    form. The inner message will actually be parsed when it is first accessed.

    This is only a hint. Implementations are free to choose whether to use
    eager or lazy parsing regardless of the value of this option. However,
    setting this option true suggests that the protocol author believes that
    using lazy parsing on this field is worth the additional bookkeeping
    overhead typically needed to implement it.
    This option does not affect the public interface of any generated code;
    all method signatures remain the same. Furthermore, thread-safety of the
    interface is not affected by this option; const methods remain safe to
    call from multiple threads concurrently, while non-const methods continue
    to require exclusive access.
    Note that implementations may choose not to check required fields within
    a lazy sub-message. That is, calling IsInitialized() on the outer message
    may return true even if the inner message has missing required fields.
    This is necessary because otherwise the inner message would have to be
    parsed in order to perform the check, defeating the purpose of lazy
    parsing. An implementation which chooses not to check required fields
    must be consistent about it. That is, for any particular sub-message, the
    implementation must either always check its required fields, or never
    check its required fields, regardless of whether or not the message has
    been parsed.

    Generated from protobuf field optional bool lazy = 5 [default = false];

    • return $this
    public setPacked( $var)
     

    The packed option can be enabled for repeated primitive fields to enable
    a more efficient representation on the wire. Rather than repeatedly
    writing the tag and type for each element, the entire array is encoded as
    a single length-delimited blob. In proto3, only explicit setting it to
    false will avoid using packed encoding.

    Generated from protobuf field optional bool packed = 2;

    • 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
    public setWeak( $var)
     

    For Google-internal migration only. Do not use.

    Generated from protobuf field optional bool weak = 10 [default = false];

    • return $this
    Properties
    protected $ctype
     

    The ctype option instructs the C++ code generator to use a different
    representation of the field than it normally would. See the specific
    options below. This option is not yet implemented in the open source
    release -- sorry, we'll try to include it in a future version!

    Generated from protobuf field optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];

    protected $deprecated
     

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

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

    protected $jstype
     

    The jstype option determines the JavaScript type used for values of the
    field. The option is permitted only for 64 bit integral and fixed types
    (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING
    is represented as JavaScript string, which avoids loss of precision that
    can happen when a large value is converted to a floating point JavaScript.

    Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
    use the JavaScript "number" type. The behavior of the default option
    JS_NORMAL is implementation dependent.
    This option is an enum to permit additional types to be added, e.g.
    goog.math.Integer.

    Generated from protobuf field optional .google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL];

    protected $lazy
     

    Should this field be parsed lazily? Lazy applies only to message-type
    fields. It means that when the outer message is initially parsed, the
    inner message's contents will not be parsed but instead stored in encoded
    form. The inner message will actually be parsed when it is first accessed.

    This is only a hint. Implementations are free to choose whether to use
    eager or lazy parsing regardless of the value of this option. However,
    setting this option true suggests that the protocol author believes that
    using lazy parsing on this field is worth the additional bookkeeping
    overhead typically needed to implement it.
    This option does not affect the public interface of any generated code;
    all method signatures remain the same. Furthermore, thread-safety of the
    interface is not affected by this option; const methods remain safe to
    call from multiple threads concurrently, while non-const methods continue
    to require exclusive access.
    Note that implementations may choose not to check required fields within
    a lazy sub-message. That is, calling IsInitialized() on the outer message
    may return true even if the inner message has missing required fields.
    This is necessary because otherwise the inner message would have to be
    parsed in order to perform the check, defeating the purpose of lazy
    parsing. An implementation which chooses not to check required fields
    must be consistent about it. That is, for any particular sub-message, the
    implementation must either always check its required fields, or never
    check its required fields, regardless of whether or not the message has
    been parsed.

    Generated from protobuf field optional bool lazy = 5 [default = false];

    protected $packed
     

    The packed option can be enabled for repeated primitive fields to enable
    a more efficient representation on the wire. Rather than repeatedly
    writing the tag and type for each element, the entire array is encoded as
    a single length-delimited blob. In proto3, only explicit setting it to
    false will avoid using packed encoding.

    Generated from protobuf field optional bool packed = 2;

    protected $weak
     

    For Google-internal migration only. Do not use.

    Generated from protobuf field optional bool weak = 10 [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_ctype
    private $has_deprecated
    private $has_jstype
    private $has_lazy
    private $has_packed
    private $has_uninterpreted_option
    private $has_weak
    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