Describes a field within a message.

Generated from protobuf message google.protobuf.FieldDescriptorProto

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

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


    • ignore
    public Google\Protobuf\Internal\Message::clear()
    public Google\Protobuf\Internal\Message::discardUnknownFields()
    public getDefaultValue()
     
    For numeric types, contains the original text representation of the value.

    For booleans, "true" or "false".
    For strings, contains the default text contents (not escaped in any way).
    For bytes, contains the C escaped value. All bytes >= 128 are escaped.
    TODO(kenton): Base-64 encode?

    Generated from protobuf field optional string default_value = 7;

    • return string
    public getExtendee()
     
    For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.

    Generated from protobuf field optional string extendee = 2;

    • return string
    public getJsonName()
     
    JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.

    Generated from protobuf field optional string json_name = 10;

    • return string
    public getLabel()
     
    Generated from protobuf field optional .google.protobuf.FieldDescriptorProto.Label label = 4;

    • return int
    public getName()
     
    Generated from protobuf field optional string name = 1;

    • return string
    public getNumber()
     
    Generated from protobuf field optional int32 number = 3;

    • return int
    public getOneofIndex()
     
    If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.

    Generated from protobuf field optional int32 oneof_index = 9;

    • return int
    public getOptions()
     
    Generated from protobuf field optional .google.protobuf.FieldOptions options = 8;

    public getType()
     
    If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.

    Generated from protobuf field optional .google.protobuf.FieldDescriptorProto.Type type = 5;

    • return int
    public getTypeName()
     
    For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).

    Generated from protobuf field optional string type_name = 6;

    • return string
    public hasDefaultValue()
    public hasExtendee()
    public hasJsonName()
    public hasLabel()
    public hasName()
    public hasNumber()
    public hasOneofIndex()
    public hasOptions()
    public hasType()
    public hasTypeName()
    public Google\Protobuf\Internal\Message::jsonByteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data)
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input)
     


    • 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 setDefaultValue( $var)
     
    For numeric types, contains the original text representation of the value.

    For booleans, "true" or "false".
    For strings, contains the default text contents (not escaped in any way).
    For bytes, contains the C escaped value. All bytes >= 128 are escaped.
    TODO(kenton): Base-64 encode?

    Generated from protobuf field optional string default_value = 7;

    • return $this
    public setExtendee( $var)
     
    For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.

    Generated from protobuf field optional string extendee = 2;

    • return $this
    public setJsonName( $var)
     
    JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.

    Generated from protobuf field optional string json_name = 10;

    • return $this
    public setLabel( $var)
     
    Generated from protobuf field optional .google.protobuf.FieldDescriptorProto.Label label = 4;

    • return $this
    public setName( $var)
     
    Generated from protobuf field optional string name = 1;

    • return $this
    public setNumber( $var)
     
    Generated from protobuf field optional int32 number = 3;

    • return $this
    public setOneofIndex( $var)
     
    If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.

    Generated from protobuf field optional int32 oneof_index = 9;

    • return $this
    public setOptions( $var)
     
    Generated from protobuf field optional .google.protobuf.FieldOptions options = 8;

    • return $this
    public setType( $var)
     
    If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.

    Generated from protobuf field optional .google.protobuf.FieldDescriptorProto.Type type = 5;

    • return $this
    public setTypeName( $var)
     
    For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).

    Generated from protobuf field optional string type_name = 6;

    • return $this
    Properties
    protected $default_value
     
    For numeric types, contains the original text representation of the value.

    For booleans, "true" or "false".
    For strings, contains the default text contents (not escaped in any way).
    For bytes, contains the C escaped value. All bytes >= 128 are escaped.
    TODO(kenton): Base-64 encode?

    Generated from protobuf field optional string default_value = 7;

    protected $extendee
     
    For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.

    Generated from protobuf field optional string extendee = 2;

    protected $json_name
     
    JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.

    Generated from protobuf field optional string json_name = 10;

    protected $label
     
    Generated from protobuf field optional .google.protobuf.FieldDescriptorProto.Label label = 4;

    protected $name
     
    Generated from protobuf field optional string name = 1;

    protected $number
     
    Generated from protobuf field optional int32 number = 3;

    protected $oneof_index
     
    If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.

    Generated from protobuf field optional int32 oneof_index = 9;

    protected $options
     
    Generated from protobuf field optional .google.protobuf.FieldOptions options = 8;

    protected $type
     
    If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.

    Generated from protobuf field optional .google.protobuf.FieldDescriptorProto.Type type = 5;

    protected $type_name
     
    For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).

    Generated from protobuf field optional string type_name = 6;

    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array)
    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_default_value
    private $has_extendee
    private $has_json_name
    private $has_label
    private $has_name
    private $has_number
    private $has_oneof_index
    private $has_options
    private $has_type
    private $has_type_name
    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $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)
    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