Describes a complete .proto file.

Generated from protobuf message google.protobuf.FileDescriptorProto

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

    Names of files imported by this file.

    Generated from protobuf field repeated string dependency = 3;

    public getEnumType()
     

    Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 5;

    public getExtension()
     

    Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 7;

    public getMessageType()
     

    All top-level definitions in this file.

    Generated from protobuf field repeated .google.protobuf.DescriptorProto message_type = 4;

    public getName()
     

    file name, relative to root of source tree

    Generated from protobuf field optional string name = 1;

    • return string
    public getOptions()
     

    Generated from protobuf field optional .google.protobuf.FileOptions options = 8;

    public getPackage()
     

    e.g. "foo", "foo.bar", etc.

    Generated from protobuf field optional string package = 2;

    • return string
    public getPublicDependency()
     

    Indexes of the public imported files in the dependency list above.

    Generated from protobuf field repeated int32 public_dependency = 10;

    public getService()
     

    Generated from protobuf field repeated .google.protobuf.ServiceDescriptorProto service = 6;

    public getSourceCodeInfo()
     

    This field contains optional information about the original source code.

    You may safely remove this entire field without harming runtime
    functionality of the descriptors -- the information is needed only by
    development tools.

    Generated from protobuf field optional .google.protobuf.SourceCodeInfo source_code_info = 9;

    public getSyntax()
     

    The syntax of the proto file.

    The supported values are "proto2" and "proto3".

    Generated from protobuf field optional string syntax = 12;

    • return string
    public getWeakDependency()
     

    Indexes of the weak imported files in the dependency list.

    For Google-internal migration only. Do not use.

    Generated from protobuf field repeated int32 weak_dependency = 11;

    public hasDependency()
    public hasEnumType()
    public hasExtension()
    public hasMessageType()
    public hasName()
    public hasOptions()
    public hasPackage()
    public hasPublicDependency()
    public hasService()
    public hasSourceCodeInfo()
    public hasSyntax()
    public hasWeakDependency()
    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 setDependency( $var)
     

    Names of files imported by this file.

    Generated from protobuf field repeated string dependency = 3;

    • return $this
    public setEnumType( $var)
     

    Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 5;

    • return $this
    public setExtension( $var)
     

    Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 7;

    • return $this
    public setMessageType( $var)
     

    All top-level definitions in this file.

    Generated from protobuf field repeated .google.protobuf.DescriptorProto message_type = 4;

    • return $this
    public setName( $var)
     

    file name, relative to root of source tree

    Generated from protobuf field optional string name = 1;

    • return $this
    public setOptions( $var)
     

    Generated from protobuf field optional .google.protobuf.FileOptions options = 8;

    • return $this
    public setPackage( $var)
     

    e.g. "foo", "foo.bar", etc.

    Generated from protobuf field optional string package = 2;

    • return $this
    public setPublicDependency( $var)
     

    Indexes of the public imported files in the dependency list above.

    Generated from protobuf field repeated int32 public_dependency = 10;

    • return $this
    public setService( $var)
     

    Generated from protobuf field repeated .google.protobuf.ServiceDescriptorProto service = 6;

    • return $this
    public setSourceCodeInfo( $var)
     

    This field contains optional information about the original source code.

    You may safely remove this entire field without harming runtime
    functionality of the descriptors -- the information is needed only by
    development tools.

    Generated from protobuf field optional .google.protobuf.SourceCodeInfo source_code_info = 9;

    • return $this
    public setSyntax( $var)
     

    The syntax of the proto file.

    The supported values are "proto2" and "proto3".

    Generated from protobuf field optional string syntax = 12;

    • return $this
    public setWeakDependency( $var)
     

    Indexes of the weak imported files in the dependency list.

    For Google-internal migration only. Do not use.

    Generated from protobuf field repeated int32 weak_dependency = 11;

    • return $this
    Properties
    protected $name
     

    file name, relative to root of source tree

    Generated from protobuf field optional string name = 1;

    protected $options
     

    Generated from protobuf field optional .google.protobuf.FileOptions options = 8;

    protected $package
     

    e.g. "foo", "foo.bar", etc.

    Generated from protobuf field optional string package = 2;

    protected $source_code_info
     

    This field contains optional information about the original source code.

    You may safely remove this entire field without harming runtime
    functionality of the descriptors -- the information is needed only by
    development tools.

    Generated from protobuf field optional .google.protobuf.SourceCodeInfo source_code_info = 9;

    protected $syntax
     

    The syntax of the proto file.

    The supported values are "proto2" and "proto3".

    Generated from protobuf field optional string syntax = 12;

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

    Names of files imported by this file.

    Generated from protobuf field repeated string dependency = 3;

    private $enum_type
     

    Generated from protobuf field repeated .google.protobuf.EnumDescriptorProto enum_type = 5;

    private $extension
     

    Generated from protobuf field repeated .google.protobuf.FieldDescriptorProto extension = 7;

    private $has_dependency
    private $has_enum_type
    private $has_extension
    private $has_message_type
    private $has_name
    private $has_options
    private $has_package
    private $has_public_dependency
    private $has_service
    private $has_source_code_info
    private $has_syntax
    private $has_weak_dependency
    private $message_type
     

    All top-level definitions in this file.

    Generated from protobuf field repeated .google.protobuf.DescriptorProto message_type = 4;

    private $public_dependency
     

    Indexes of the public imported files in the dependency list above.

    Generated from protobuf field repeated int32 public_dependency = 10;

    private $service
     

    Generated from protobuf field repeated .google.protobuf.ServiceDescriptorProto service = 6;

    private $weak_dependency
     

    Indexes of the weak imported files in the dependency list.

    For Google-internal migration only. Do not use.

    Generated from protobuf field repeated int32 weak_dependency = 11;

    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