MDL-48766 lib: Import MaxMind GeoIP2 PHP API
[moodle.git] / lib / maxmind / GeoIp2 / Model / Insights.php
1 <?php
3 namespace GeoIp2\Model;
5 /**
6  * Model class for the data returned by GeoIP2 Precision: Insights web service.
7  *
8  * The only difference between the City and Insights model classes is which
9  * fields in each record may be populated. See
10  * http://dev.maxmind.com/geoip/geoip2/web-services more details.
11  *
12  * @property-read \GeoIp2\Record\City $city City data for the requested IP
13  * address.
14  *
15  * @property-read \GeoIp2\Record\Continent $continent Continent data for the
16  * requested IP address.
17  *
18  * @property-read \GeoIp2\Record\Country $country Country data for the requested
19  * IP address. This object represents the country where MaxMind believes the
20  * end user is located.
21  *
22  * @property-read \GeoIp2\Record\Location $location Location data for the
23  * requested IP address.
24  *
25  * @property-read \GeoIp2\Record\MaxMind $maxmind Data related to your MaxMind
26  * account.
27  *
28  * @property-read \GeoIp2\Record\Country $registeredCountry Registered country
29  * data for the requested IP address. This record represents the country
30  * where the ISP has registered a given IP block and may differ from the
31  * user's country.
32  *
33  * @property-read \GeoIp2\Record\RepresentedCountry $representedCountry
34  * Represented country data for the requested IP address. The represented
35  * country is used for things like military bases. It is only present when
36  * the represented country differs from the country.
37  *
38  * @property-read array $subdivisions An array of {@link \GeoIp2\Record\Subdivision}
39  * objects representing the country subdivisions for the requested IP
40  * address. The number and type of subdivisions varies by country, but a
41  * subdivision is typically a state, province, county, etc. Subdivisions
42  * are ordered from most general (largest) to most specific (smallest).
43  * If the response did not contain any subdivisions, this method returns
44  * an empty array.
45  *
46  * @property-read \GeoIp2\Record\Subdivision $mostSpecificSubdivision An  object
47  * representing the most specific subdivision returned. If the response
48  * did not contain any subdivisions, this method returns an empty
49  * {@link \GeoIp2\Record\Subdivision} object.
50  *
51  * @property-read \GeoIp2\Record\Traits $traits Data for the traits of the
52  * requested IP address.
53  */
54 class Insights extends City
55 {
56 }