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