1<?php
2
3namespace GeoIp2\Record;
4
5/**
6 * Contains data for the subdivisions associated with an IP address.
7 *
8 * This record is returned by all location databases and services besides
9 * Country.
10 *
11 * @property-read int|null $confidence This is a value from 0-100 indicating
12 * MaxMind's confidence that the subdivision is correct. This attribute is
13 * only available from the Insights service and the GeoIP2 Enterprise
14 * database.
15 * @property-read int|null $geonameId This is a GeoName ID for the subdivision.
16 * This attribute is returned by all location databases and services besides
17 * Country.
18 * @property-read string|null $isoCode This is a string up to three characters long
19 * contain the subdivision portion of the
20 * {@link * http://en.wikipedia.org/wiki/ISO_3166-2 ISO 3166-2 code}. This attribute
21 * is returned by all location databases and services except Country.
22 * @property-read string|null $name The name of the subdivision based on the
23 * locales list passed to the constructor. This attribute is returned by all
24 * location databases and services besides Country.
25 * @property-read array|null $names An array map where the keys are locale codes
26 * and the values are names. This attribute is returned by all location
27 * databases and services besides Country.
28 */
29class Subdivision extends AbstractPlaceRecord
30{
31    /**
32     * @ignore
33     */
34    protected $validAttributes = [
35        'confidence',
36        'geonameId',
37        'isoCode',
38        'names',
39    ];
40}
41