1<?php
2
3namespace GeoIp2\Record;
4
5/**
6 * Contains data for the location record 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 $averageIncome The average income in US dollars
12 * associated with the requested IP address. This attribute is only available
13 * from the Insights service.
14 * @property-read int|null $accuracyRadius The approximate accuracy radius in
15 * kilometers around the latitude and longitude for the IP address. This is
16 * the radius where we have a 67% confidence that the device using the IP
17 * address resides within the circle centered at the latitude and longitude
18 * with the provided radius.
19 * @property-read float|null $latitude The approximate latitude of the location
20 * associated with the IP address. This value is not precise and should not be
21 * used to identify a particular address or household.
22 * @property-read float|null $longitude The approximate longitude of the location
23 * associated with the IP address. This value is not precise and should not be
24 * used to identify a particular address or household.
25 * @property-read int|null $populationDensity The estimated population per square
26 * kilometer associated with the IP address. This attribute is only available
27 * from the Insights service.
28 * @property-read int|null $metroCode The metro code of the location if the location
29 * is in the US. MaxMind returns the same metro codes as the
30 * {@link * https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions
31 * Google AdWords API}.
32 * @property-read string|null $timeZone The time zone associated with location, as
33 * specified by the {@link http://www.iana.org/time-zones IANA Time Zone
34 * Database}, e.g., "America/New_York".
35 */
36class Location extends AbstractRecord
37{
38    /**
39     * @ignore
40     */
41    protected $validAttributes = [
42        'averageIncome',
43        'accuracyRadius',
44        'latitude',
45        'longitude',
46        'metroCode',
47        'populationDensity',
48        'postalCode',
49        'postalConfidence',
50        'timeZone',
51    ];
52}
53