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