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