Represents a postal address, e.g. for postal delivery or payments addresses.

Given a postal address, a postal service can deliver items to a premise, P.O.
Box or similar.
It is not intended to model geographical locations (roads, towns,
mountains).
In typical usage an address would be created via user input or from importing
existing data, depending on the type of process.
Advice on address input / editing:

Generated from protobuf message google.type.PostalAddress

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

    Unstructured address lines describing the lower levels of an address.

    Because values in address_lines do not have type information and may
    sometimes contain multiple values in a single field (e.g.
    "Austin, TX"), it is important that the line order is clear. The order of
    address lines should be "envelope order" for the country/region of the
    address. In places where this can vary (e.g. Japan), address_language is
    used to make it explicit (e.g. "ja" for large-to-small ordering and
    "ja-Latn" or "en" for small-to-large). This way, the most specific line of
    an address can be selected based on the language.
    The minimum permitted structural representation of an address consists
    of a region_code with all remaining information placed in the
    address_lines. It would be possible to format such an address very
    approximately without geocoding, but no semantic reasoning could be
    made about any of the address components until it was at least
    partially resolved.
    Creating an address only containing a region_code and address_lines, and
    then geocoding is the recommended way to handle completely unstructured
    addresses (as opposed to guessing which parts of the address should be
    localities or administrative areas).

    Generated from protobuf field repeated string address_lines = 9;

    public getAdministrativeArea()
     

    Optional. Highest administrative subdivision which is used for postal
    addresses of a country or region.

    For example, this can be a state, a province, an oblast, or a prefecture.
    Specifically, for Spain this is the province and not the autonomous
    community (e.g. "Barcelona" and not "Catalonia").
    Many countries don't use an administrative area in postal addresses. E.g.
    in Switzerland this should be left unpopulated.

    Generated from protobuf field string administrative_area = 6;

    • return string
    public getLanguageCode()
     

    Optional. BCP-47 language code of the contents of this address (if
    known). This is often the UI language of the input form or is expected
    to match one of the languages used in the address' country/region, or their
    transliterated equivalents.

    This can affect formatting in certain countries, but is not critical
    to the correctness of the data and will never affect any validation or
    other non-formatting related operations.
    If this value is not known, it should be omitted (rather than specifying a
    possibly incorrect default).
    Examples: "zh-Hant", "ja", "ja-Latn", "en".

    Generated from protobuf field string language_code = 3;

    • return string
    public getLocality()
     

    Optional. Generally refers to the city/town portion of the address.

    Examples: US city, IT comune, UK post town.
    In regions of the world where localities are not well defined or do not fit
    into this structure well, leave locality empty and use address_lines.

    Generated from protobuf field string locality = 7;

    • return string
    public getOrganization()
     

    Optional. The name of the organization at the address.

    Generated from protobuf field string organization = 11;

    • return string
    public getPostalCode()
     

    Optional. Postal code of the address. Not all countries use or require
    postal codes to be present, but where they are used, they may trigger
    additional validation with other parts of the address (e.g. state/zip
    validation in the U.S.A.).

    Generated from protobuf field string postal_code = 4;

    • return string
    public getRecipients()
     

    Optional. The recipient at the address.

    This field may, under certain circumstances, contain multiline information.
    For example, it might contain "care of" information.

    Generated from protobuf field repeated string recipients = 10;

    public getRegionCode()
     

    Required. CLDR region code of the country/region of the address. This
    is never inferred and it is up to the user to ensure the value is
    correct. See http://cldr.unicode.org/ and
    http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
    for details. Example: "CH" for Switzerland.

    Generated from protobuf field string region_code = 2;

    • return string
    public getRevision()
     

    The schema revision of the PostalAddress. This must be set to 0, which is
    the latest revision.

    All new revisions must be backward compatible with old revisions.

    Generated from protobuf field int32 revision = 1;

    • return int
    public getSortingCode()
     

    Optional. Additional, country-specific, sorting code. This is not used
    in most regions. Where it is used, the value is either a string like
    "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
    alone, representing the "sector code" (Jamaica), "delivery area indicator"
    (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

    Generated from protobuf field string sorting_code = 5;

    • return string
    public getSublocality()
     

    Optional. Sublocality of the address.

    For example, this can be neighborhoods, boroughs, districts.

    Generated from protobuf field string sublocality = 8;

    • return string
    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 setAddressLines( $var)
     

    Unstructured address lines describing the lower levels of an address.

    Because values in address_lines do not have type information and may
    sometimes contain multiple values in a single field (e.g.
    "Austin, TX"), it is important that the line order is clear. The order of
    address lines should be "envelope order" for the country/region of the
    address. In places where this can vary (e.g. Japan), address_language is
    used to make it explicit (e.g. "ja" for large-to-small ordering and
    "ja-Latn" or "en" for small-to-large). This way, the most specific line of
    an address can be selected based on the language.
    The minimum permitted structural representation of an address consists
    of a region_code with all remaining information placed in the
    address_lines. It would be possible to format such an address very
    approximately without geocoding, but no semantic reasoning could be
    made about any of the address components until it was at least
    partially resolved.
    Creating an address only containing a region_code and address_lines, and
    then geocoding is the recommended way to handle completely unstructured
    addresses (as opposed to guessing which parts of the address should be
    localities or administrative areas).

    Generated from protobuf field repeated string address_lines = 9;

    • return $this
    public setAdministrativeArea( $var)
     

    Optional. Highest administrative subdivision which is used for postal
    addresses of a country or region.

    For example, this can be a state, a province, an oblast, or a prefecture.
    Specifically, for Spain this is the province and not the autonomous
    community (e.g. "Barcelona" and not "Catalonia").
    Many countries don't use an administrative area in postal addresses. E.g.
    in Switzerland this should be left unpopulated.

    Generated from protobuf field string administrative_area = 6;

    • return $this
    public setLanguageCode( $var)
     

    Optional. BCP-47 language code of the contents of this address (if
    known). This is often the UI language of the input form or is expected
    to match one of the languages used in the address' country/region, or their
    transliterated equivalents.

    This can affect formatting in certain countries, but is not critical
    to the correctness of the data and will never affect any validation or
    other non-formatting related operations.
    If this value is not known, it should be omitted (rather than specifying a
    possibly incorrect default).
    Examples: "zh-Hant", "ja", "ja-Latn", "en".

    Generated from protobuf field string language_code = 3;

    • return $this
    public setLocality( $var)
     

    Optional. Generally refers to the city/town portion of the address.

    Examples: US city, IT comune, UK post town.
    In regions of the world where localities are not well defined or do not fit
    into this structure well, leave locality empty and use address_lines.

    Generated from protobuf field string locality = 7;

    • return $this
    public setOrganization( $var)
     

    Optional. The name of the organization at the address.

    Generated from protobuf field string organization = 11;

    • return $this
    public setPostalCode( $var)
     

    Optional. Postal code of the address. Not all countries use or require
    postal codes to be present, but where they are used, they may trigger
    additional validation with other parts of the address (e.g. state/zip
    validation in the U.S.A.).

    Generated from protobuf field string postal_code = 4;

    • return $this
    public setRecipients( $var)
     

    Optional. The recipient at the address.

    This field may, under certain circumstances, contain multiline information.
    For example, it might contain "care of" information.

    Generated from protobuf field repeated string recipients = 10;

    • return $this
    public setRegionCode( $var)
     

    Required. CLDR region code of the country/region of the address. This
    is never inferred and it is up to the user to ensure the value is
    correct. See http://cldr.unicode.org/ and
    http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
    for details. Example: "CH" for Switzerland.

    Generated from protobuf field string region_code = 2;

    • return $this
    public setRevision( $var)
     

    The schema revision of the PostalAddress. This must be set to 0, which is
    the latest revision.

    All new revisions must be backward compatible with old revisions.

    Generated from protobuf field int32 revision = 1;

    • return $this
    public setSortingCode( $var)
     

    Optional. Additional, country-specific, sorting code. This is not used
    in most regions. Where it is used, the value is either a string like
    "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
    alone, representing the "sector code" (Jamaica), "delivery area indicator"
    (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

    Generated from protobuf field string sorting_code = 5;

    • return $this
    public setSublocality( $var)
     

    Optional. Sublocality of the address.

    For example, this can be neighborhoods, boroughs, districts.

    Generated from protobuf field string sublocality = 8;

    • return $this
    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 $address_lines
     

    Unstructured address lines describing the lower levels of an address.

    Because values in address_lines do not have type information and may
    sometimes contain multiple values in a single field (e.g.
    "Austin, TX"), it is important that the line order is clear. The order of
    address lines should be "envelope order" for the country/region of the
    address. In places where this can vary (e.g. Japan), address_language is
    used to make it explicit (e.g. "ja" for large-to-small ordering and
    "ja-Latn" or "en" for small-to-large). This way, the most specific line of
    an address can be selected based on the language.
    The minimum permitted structural representation of an address consists
    of a region_code with all remaining information placed in the
    address_lines. It would be possible to format such an address very
    approximately without geocoding, but no semantic reasoning could be
    made about any of the address components until it was at least
    partially resolved.
    Creating an address only containing a region_code and address_lines, and
    then geocoding is the recommended way to handle completely unstructured
    addresses (as opposed to guessing which parts of the address should be
    localities or administrative areas).

    Generated from protobuf field repeated string address_lines = 9;

    private $administrative_area
     

    Optional. Highest administrative subdivision which is used for postal
    addresses of a country or region.

    For example, this can be a state, a province, an oblast, or a prefecture.
    Specifically, for Spain this is the province and not the autonomous
    community (e.g. "Barcelona" and not "Catalonia").
    Many countries don't use an administrative area in postal addresses. E.g.
    in Switzerland this should be left unpopulated.

    Generated from protobuf field string administrative_area = 6;

    private $language_code
     

    Optional. BCP-47 language code of the contents of this address (if
    known). This is often the UI language of the input form or is expected
    to match one of the languages used in the address' country/region, or their
    transliterated equivalents.

    This can affect formatting in certain countries, but is not critical
    to the correctness of the data and will never affect any validation or
    other non-formatting related operations.
    If this value is not known, it should be omitted (rather than specifying a
    possibly incorrect default).
    Examples: "zh-Hant", "ja", "ja-Latn", "en".

    Generated from protobuf field string language_code = 3;

    private $locality
     

    Optional. Generally refers to the city/town portion of the address.

    Examples: US city, IT comune, UK post town.
    In regions of the world where localities are not well defined or do not fit
    into this structure well, leave locality empty and use address_lines.

    Generated from protobuf field string locality = 7;

    private $organization
     

    Optional. The name of the organization at the address.

    Generated from protobuf field string organization = 11;

    private $postal_code
     

    Optional. Postal code of the address. Not all countries use or require
    postal codes to be present, but where they are used, they may trigger
    additional validation with other parts of the address (e.g. state/zip
    validation in the U.S.A.).

    Generated from protobuf field string postal_code = 4;

    private $recipients
     

    Optional. The recipient at the address.

    This field may, under certain circumstances, contain multiline information.
    For example, it might contain "care of" information.

    Generated from protobuf field repeated string recipients = 10;

    private $region_code
     

    Required. CLDR region code of the country/region of the address. This
    is never inferred and it is up to the user to ensure the value is
    correct. See http://cldr.unicode.org/ and
    http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
    for details. Example: "CH" for Switzerland.

    Generated from protobuf field string region_code = 2;

    private $revision
     

    The schema revision of the PostalAddress. This must be set to 0, which is
    the latest revision.

    All new revisions must be backward compatible with old revisions.

    Generated from protobuf field int32 revision = 1;

    private $sorting_code
     

    Optional. Additional, country-specific, sorting code. This is not used
    in most regions. Where it is used, the value is either a string like
    "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
    alone, representing the "sector code" (Jamaica), "delivery area indicator"
    (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

    Generated from protobuf field string sorting_code = 5;

    private $sublocality
     

    Optional. Sublocality of the address.

    For example, this can be neighborhoods, boroughs, districts.

    Generated from protobuf field string sublocality = 8;

    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