A single field of a message type.

Generated from protobuf message google.protobuf.Field

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 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;

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


    • 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 setCardinality( $var)
     
    The field cardinality.

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

    • 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;

    • return $this
    public setJsonName( $var)
     
    The field JSON name.

    Generated from protobuf field string json_name = 10;

    • return $this
    public setKind( $var)
     
    The field type.

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

    • return $this
    public setName( $var)
     
    The field name.

    Generated from protobuf field string name = 4;

    • return $this
    public setNumber( $var)
     
    The field number.

    Generated from protobuf field int32 number = 3;

    • 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;

    • return $this
    public setOptions( $var)
     
    The protocol buffer options.

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

    • return $this
    public setPacked( $var)
     
    Whether to use alternative packed wire representation.

    Generated from protobuf field bool packed = 8;

    • 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;

    • return $this
    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 $cardinality
     
    The field cardinality.

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

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

    Generated from protobuf field string default_value = 11;

    private $json_name
     
    The field JSON name.

    Generated from protobuf field string json_name = 10;

    private $kind
     
    The field type.

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

    private $name
     
    The field name.

    Generated from protobuf field string name = 4;

    private $number
     
    The field number.

    Generated from protobuf field int32 number = 3;

    private $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.

    Generated from protobuf field int32 oneof_index = 7;

    private $options
     
    The protocol buffer options.

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

    private $packed
     
    Whether to use alternative packed wire representation.

    Generated from protobuf field bool packed = 8;

    private $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
    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