GeoIP2-php/src/GeoIp2/Record/RepresentedCountry.php

46 lines
1.6 KiB
PHP
Raw Normal View History

2013-05-07 17:02:39 +00:00
<?php
namespace GeoIp2\Record;
2013-05-07 17:06:57 +00:00
2013-05-10 17:47:11 +00:00
/**
* Contains data for the represented country associated with an IP address
*
* This class contains the country-level data associated with an IP address
* for the IP's represented country. The represented country is the country
* represented by something like a military base or embassy.
*
* This record is returned by all the end points.
*
* @property int $confidence A value from 0-100 indicating MaxMind's
* confidence that the country is correct. This attribute is only available
2014-07-15 21:19:30 +00:00
* from the Insights end point.
2013-05-10 17:47:11 +00:00
*
* @property int $geonameId The GeoName ID for the country. This attribute is
* returned by all end points.
*
* @property string $isoCode The {@link http://en.wikipedia.org/wiki/ISO_3166-1
* two-character ISO 3166-1 alpha code} for the country. This attribute is
* returned by all end points.
*
* @property string $name The name of the country based on the locales list
2013-05-10 17:47:11 +00:00
* passed to the constructor. This attribute is returned by all end points.
*
2013-10-17 17:28:31 +00:00
* @property array $names An array map where the keys are locale codes and
2013-05-10 17:47:11 +00:00
* the values are names. This attribute is returned by all end points.
*
* @property string $type A string indicating the type of entity that is
* representing the country. Currently we only return <code>military</code>
* but this could expand to include other types such as <code>embassy</code>
* in the future. Returned by all endpoints.
*/
class RepresentedCountry extends Country
2013-05-07 17:06:57 +00:00
{
protected $validAttributes = array(
'confidence',
'geonameId',
'isoCode',
'namespace',
'type'
);
}