Added basic docs for the API

src/GeoIP2/Model/City.php

@@ -2,13 +2,75 @@
 
 namespace GeoIP2\Model;
 
+/**
+ * This class provides a model for the data returned by the GeoIP2 Precision
+ * City end point.
+ *
+ * The only difference between the City, City/ISP/Org, and Omni model
+ * classes is which fields in each record may be populated. See
+ * http://dev.maxmind.com/geoip/geoip2/web-services more details.
+ *
+ * @property \GeoIP2\Record\City $city Country data for the requested IP
+ * address.
+ *
+ * @property \GeoIP2\Record\Continent $continent Continent data for the
+ * requested IP address.
+ *
+ * @property \GeoIP2\Record\Country $country Country data for the requested
+ * IP address. This object represents the country where MaxMind believes the
+ * end user is located.
+ *
+ * @property \GeoIP2\Record\Location $location Location data for the
+ * requested IP address.
+ *
+ * @property \GeoIP2\Record\Country $registeredCountry Registered country
+ * data for the requested IP address. This record represents the country
+ * where the ISP has registered a given IP block in and may differ from the
+ * user's country.
+ *
+ * @property \GeoIP2\Record\RepresentedCountry $representedCountry
+ * Represented country data for the requested IP address. The represented
+ * country is used for things like military bases or embassies. It is only
+ * present when the represented country differs from the country.
+ *
+ * @property array $subdivisions An array of {@link \GeoIP2\Record\Subdivision}
+ * objects representing the country subdivisions for the requested IP
+ * address. The number and type of subdivisions varies by country, but a
+ * subdivision is typically a state, province, county, etc. Subdivisions
+ * are ordered from most general (largest) to most specific (smallest).
+ * If the response did not contain any subdivisions, this method returns
+ * an empty array.
+ *
+ * @property \GeoIP2\Record\Subdivision $mostSpecificSubdivision An  object
+ * representing the most specific subdivision returned. If the response
+ * did not contain any subdivisions, this method returns an empty
+ * {@link \GeoIP2\Record\Subdivision} object.
+ *
+ * @property \GeoIP2\Record\Traits $traits Data for the traits of the
+ * requested IP address.
+ */
 class City extends Country
 {
+    /**
+     * @ignore
+     */
     protected $city;
+    /**
+     * @ignore
+     */
     protected $location;
+    /**
+     * @ignore
+     */
     protected $postal;
+    /**
+     * @ignore
+     */
     protected $subdivisions = array();
 
+    /**
+     * @ignore
+     */
     public function __construct($raw, $languages)
     {
         parent::__construct($raw, $languages);
@@ -34,6 +96,9 @@ class City extends Country
         }
     }
 
+    /**
+     * @ignore
+     */
     public function __get($attr)
     {
         if ($attr == 'mostSpecificSubdivision') {

src/GeoIP2/Model/CityIspOrg.php

@@ -2,6 +2,53 @@
 
 namespace GeoIP2\Model;
 
+/**
+ * This class provides a model for the data returned by the GeoIP2 Precision
+ * City/ISP/Org end point.
+ *
+ * The only difference between the City, City/ISP/Org, and Omni model
+ * classes is which fields in each record may be populated. See
+ * http://dev.maxmind.com/geoip/geoip2/web-services more details.
+ *
+ * @property \GeoIP2\Record\City $city Country data for the requested IP
+ * address.
+ *
+ * @property \GeoIP2\Record\Continent $continent Continent data for the
+ * requested IP address.
+ *
+ * @property \GeoIP2\Record\Country $country Country data for the requested
+ * IP address. This object represents the country where MaxMind believes the
+ * end user is located.
+ *
+ * @property \GeoIP2\Record\Location $location Location data for the
+ * requested IP address.
+ *
+ * @property \GeoIP2\Record\Country $registeredCountry Registered country
+ * data for the requested IP address. This record represents the country
+ * where the ISP has registered a given IP block in and may differ from the
+ * user's country.
+ *
+ * @property \GeoIP2\Record\RepresentedCountry $representedCountry
+ * Represented country data for the requested IP address. The represented
+ * country is used for things like military bases or embassies. It is only
+ * present when the represented country differs from the country.
+ *
+ * @property array $subdivisions An array of {@link \GeoIP2\Record\Subdivision}
+ * objects representing the country subdivisions for the requested IP
+ * address. The number and type of subdivisions varies by country, but a
+ * subdivision is typically a state, province, county, etc. Subdivisions
+ * are ordered from most general (largest) to most specific (smallest).
+ * If the response did not contain any subdivisions, this method returns
+ * an empty array.
+ *
+ * @property \GeoIP2\Record\Subdivision $mostSpecificSubdivision An  object
+ * representing the most specific subdivision returned. If the response
+ * did not contain any subdivisions, this method returns an empty
+ * {@link \GeoIP2\Record\Subdivision} object.
+ *
+ * @property \GeoIP2\Record\Traits $traits Data for the traits of the
+ * requested IP address.
+ */
 class CityIspOrg extends City
 {
 }

src/GeoIP2/Model/Country.php

@@ -2,6 +2,34 @@
 
 namespace GeoIP2\Model;
 
+/**
+ * This class provides a model for the data returned by the GeoIP2 Country
+ * end point.
+ *
+ * The only difference between the City, City/ISP/Org, and Omni model
+ * classes is which fields in each record may be populated. See
+ * http://dev.maxmind.com/geoip/geoip2/web-services more details.
+ *
+ * @property \GeoIP2\Record\Continent $continent Continent data for the
+ * requested IP address.
+ *
+ * @property \GeoIP2\Record\Country $country Country data for the requested
+ * IP address. This object represents the country where MaxMind believes the
+ * end user is located.
+ *
+ * @property \GeoIP2\Record\Country $registeredCountry Registered country
+ * data for the requested IP address. This record represents the country
+ * where the ISP has registered a given IP block in and may differ from the
+ * user's country.
+ *
+ * @property \GeoIP2\Record\RepresentedCountry $representedCountry
+ * Represented country data for the requested IP address. The represented
+ * country is used for things like military bases or embassies. It is only
+ * present when the represented country differs from the country.
+ *
+ * @property \GeoIP2\Record\Traits $traits Data for the traits of the
+ * requested IP address.
+ */
 class Country
 {
     private $continent;
@@ -12,6 +40,9 @@ class Country
     private $traits;
     private $raw;
 
+    /**
+     * @ignore
+     */
     public function __construct($raw, $languages)
     {
         $this->raw = $raw;
@@ -37,11 +68,17 @@ class Country
         $this->languages = $languages;
     }
 
+    /**
+     * @ignore
+     */
     protected function get($field)
     {
         return isset($this->raw[$field]) ? $this->raw[$field] : array();
     }
 
+    /**
+     * @ignore
+     */
     public function __get ($attr)
     {
         if ($attr != "instance" && isset($this->$attr)) {

src/GeoIP2/Model/Omni.php

@@ -2,6 +2,53 @@
 
 namespace GeoIP2\Model;
 
+/**
+ * This class provides a model for the data returned by the GeoIP2 Precision
+ * Omni end point.
+ *
+ * The only difference between the City, City/ISP/Org, and Omni model
+ * classes is which fields in each record may be populated. See
+ * http://dev.maxmind.com/geoip/geoip2/web-services more details.
+ *
+ * @property \GeoIP2\Record\City $city Country data for the requested IP
+ * address.
+ *
+ * @property \GeoIP2\Record\Continent $continent Continent data for the
+ * requested IP address.
+ *
+ * @property \GeoIP2\Record\Country $country Country data for the requested
+ * IP address. This object represents the country where MaxMind believes the
+ * end user is located.
+ *
+ * @property \GeoIP2\Record\Location $location Location data for the
+ * requested IP address.
+ *
+ * @property \GeoIP2\Record\Country $registeredCountry Registered country
+ * data for the requested IP address. This record represents the country
+ * where the ISP has registered a given IP block in and may differ from the
+ * user's country.
+ *
+ * @property \GeoIP2\Record\RepresentedCountry $representedCountry
+ * Represented country data for the requested IP address. The represented
+ * country is used for things like military bases or embassies. It is only
+ * present when the represented country differs from the country.
+ *
+ * @property array $subdivisions An array of {@link \GeoIP2\Record\Subdivision}
+ * objects representing the country subdivisions for the requested IP
+ * address. The number and type of subdivisions varies by country, but a
+ * subdivision is typically a state, province, county, etc. Subdivisions
+ * are ordered from most general (largest) to most specific (smallest).
+ * If the response did not contain any subdivisions, this method returns
+ * an empty array.
+ *
+ * @property \GeoIP2\Record\Subdivision $mostSpecificSubdivision An  object
+ * representing the most specific subdivision returned. If the response
+ * did not contain any subdivisions, this method returns an empty
+ * {@link \GeoIP2\Record\Subdivision} object.
+ *
+ * @property \GeoIP2\Record\Traits $traits Data for the traits of the
+ * requested IP address.
+ */
 class Omni extends CityIspOrg
 {
 }