Merge pull request #310 from maxmind/greg/stf-555

horgh · web-flow · commit c7f5661af2a6 · 2026-05-29T15:56:00.000-07:00
Use 'GeoIP'/'GeoLite' branding in documentation
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,8 @@ CHANGELOG
   `subdivisions` array. This provides compatibility with some third-party
   databases that publish empty subdivisions arrays. Pull request by Jarek
   Jakubowski. GitHub #290.
+* The `GeoIP2` prefix in web service error messages has been changed to
+  `GeoIP`.
 
 3.3.0 (2025-11-20)
 ------------------
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -5,8 +5,8 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 ## Project Overview
 
 **GeoIP2-php** is MaxMind's official PHP client library for:
-- **GeoIP2/GeoLite2 Web Services**: Country, City, and Insights endpoints
-- **GeoIP2/GeoLite2 Databases**: Local MMDB file reading for various database types (City, Country, ASN, Anonymous IP, Anonymous Plus, ISP, etc.)
+- **GeoIP/GeoLite Web Services**: Country, City Plus, and Insights endpoints
+- **GeoIP/GeoLite Databases**: Local MMDB file reading for various database types (City, Country, ASN, Anonymous IP, Anonymous Plus, ISP, etc.)
 
 The library provides both web service clients and database readers that return strongly-typed model objects containing geographic, ISP, anonymizer, and other IP-related data.
 
@@ -323,6 +323,6 @@ vendor/bin/phpunit
 ## Additional Resources
 
 - [API Documentation](https://maxmind.github.io/GeoIP2-php/)
-- [GeoIP2 Web Services Docs](https://dev.maxmind.com/geoip/docs/web-services)
+- [GeoIP Web Services Docs](https://dev.maxmind.com/geoip/docs/web-services)
 - [MaxMind DB Format](https://maxmind.github.io/MaxMind-DB/)
 - GitHub Issues: https://github.com/maxmind/GeoIP2-php/issues
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-# GeoIP2 PHP API
+# GeoIP PHP API
 
 ## Description
 
-This package provides an API for the GeoIP2 and GeoLite2
+This package provides an API for the GeoIP and GeoLite
 [web services](https://dev.maxmind.com/geoip/docs/web-services?lang=en) and
 [databases](https://dev.maxmind.com/geoip/docs/databases?lang=en).
 
@@ -46,7 +46,7 @@ require 'vendor/autoload.php';
 
 Although we strongly recommend using Composer, we also provide a
 [phar archive](https://php.net/manual/en/book.phar.php) containing most of the
-dependencies for GeoIP2. Our latest phar archive is available on
+dependencies for GeoIP. Our latest phar archive is available on
 [our releases page](https://github.com/maxmind/GeoIP2-php/releases).
 
 ### Install Dependencies
@@ -80,15 +80,15 @@ require 'geoip2.phar';
 
 The [MaxMind DB API](https://github.com/maxmind/MaxMind-DB-Reader-php)
 includes an optional C extension that you may install to dramatically increase
-the performance of lookups in GeoIP2 or GeoLite2 databases. To install, please
+the performance of lookups in GeoIP or GeoLite databases. To install, please
 follow the instructions included with that API.
 
 The extension has no effect on web-service lookups.
 
 ## IP Geolocation Usage
 
 IP geolocation is inherently imprecise. Locations are often near the center of
-the population. Any location provided by a GeoIP2 database or web service
+the population. Any location provided by a GeoIP database or web service
 should not be used to identify a particular address or household.
 
 ## Database Reader
@@ -304,14 +304,14 @@ argument specifies the language preferences when using the `->name` method on
 the model classes that this client creates. The fourth argument is additional
 options such as `host` and `timeout`.
 
-For instance, to call the GeoLite2 web service instead of the GeoIP2 web
+For instance, to call the GeoLite web service instead of the GeoIP web
 service:
 
 ```php
 $client = new Client(42, 'abcdef123456', ['en'], ['host' => 'geolite.info']);
 ```
 
-To call the Sandbox GeoIP2 web service instead of the production GeoIP2 web
+To call the Sandbox GeoIP web service instead of the production GeoIP web
 service:
 
 ```php
@@ -344,10 +344,10 @@ use GeoIp2\WebService\Client;
 // This creates a Client object that can be reused across requests.
 // Replace "42" with your account ID and "license_key" with your license
 // key. Set the "host" to "geolite.info" in the fourth argument options
-// array to use the GeoLite2 web service instead of the GeoIP2 web
+// array to use the GeoLite web service instead of the GeoIP web
 // service. Set the "host" to "sandbox.maxmind.com" in the fourth argument
-// options array to use the Sandbox GeoIP2 web service instead of the
-// production GeoIP2 web service.
+// options array to use the Sandbox GeoIP web service instead of the
+// production GeoIP web service.
 $client = new Client(42, 'abcdef123456');
 
 // Replace "city" with the method corresponding to the web service that
@@ -398,7 +398,7 @@ Because of these factors, it is possible for any endpoint to return a record
 where some or all of the attributes are unpopulated.
 
 See the
-[GeoIP2 web service docs](https://dev.maxmind.com/geoip/docs/web-services?lang=en)
+[GeoIP web service docs](https://dev.maxmind.com/geoip/docs/web-services?lang=en)
 for details on what data each endpoint may return.
 
 The only piece of data which is always returned is the `ipAddress` attribute
@@ -411,7 +411,7 @@ databases with data on geographical features around the world, including
 populated places. They offer both free and paid premium data. Each feature is
 uniquely identified by a `geonameId`, which is an integer.
 
-Many of the records returned by the GeoIP2 web services and databases include
+Many of the records returned by the GeoIP web services and databases include
 a `geonameId` property. This is the ID of a geographical feature (city,
 region, country, etc.) in the GeoNames database.
 
@@ -460,7 +460,7 @@ initial clone, or from https://github.com/maxmind/MaxMind-DB
 
 ## Versioning
 
-The GeoIP2 PHP API uses [Semantic Versioning](https://semver.org/).
+The GeoIP PHP API uses [Semantic Versioning](https://semver.org/).
 
 ## Copyright and License
 
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "geoip2/geoip2",
-    "description": "MaxMind GeoIP2 PHP API",
+    "description": "MaxMind GeoIP PHP API",
     "keywords": ["geoip", "geoip2", "geolocation", "ip", "maxmind"],
     "homepage": "https://github.com/maxmind/GeoIP2-php",
     "type": "library",
diff --git a/dev-bin/release.sh b/dev-bin/release.sh
@@ -157,7 +157,7 @@ rm -rf "$cachedir"
 php phpDocumentor.phar \
     --visibility=public \
     --cache-folder="$cachedir" \
-    --title="GeoIP2 PHP API $tag" \
+    --title="GeoIP PHP API $tag" \
     run \
     -d "$PWD/../src" \
     -t "doc/$tag"
diff --git a/docs/hugo.toml b/docs/hugo.toml
@@ -1,4 +1,4 @@
-title = "MaxMind GeoIP2 PHP API"
+title = "MaxMind GeoIP PHP API"
 disableKinds = ["taxonomy", "term", "RSS"]
 
 [[cascade]]
diff --git a/src/Database/Reader.php b/src/Database/Reader.php
@@ -20,7 +20,7 @@
 use MaxMind\Db\Reader\Metadata;
 
 /**
- * Instances of this class provide a reader for the GeoIP2 database format.
+ * Instances of this class provide a reader for the GeoIP database format.
  * IP addresses can be looked up using the database specific methods.
  *
  * ## Usage ##
@@ -51,7 +51,7 @@ class Reader implements ProviderInterface
     /**
      * Constructor.
      *
-     * @param string        $filename the path to the GeoIP2 database file
+     * @param string        $filename the path to the GeoIP database file
      * @param array<string> $locales  list of locale codes to use in name property
      *                                from most preferred to least preferred
      *
@@ -67,7 +67,7 @@ public function __construct(
     }
 
     /**
-     * This method returns a GeoIP2 City model.
+     * This method returns a GeoIP City model.
      *
      * @param string $ipAddress an IPv4 or IPv6 address as a string
      *
@@ -81,7 +81,7 @@ public function city(string $ipAddress): City
     }
 
     /**
-     * This method returns a GeoIP2 Country model.
+     * This method returns a GeoIP Country model.
      *
      * @param string $ipAddress an IPv4 or IPv6 address as a string
      *
@@ -95,7 +95,7 @@ public function country(string $ipAddress): Country
     }
 
     /**
-     * This method returns a GeoIP2 Anonymous IP model.
+     * This method returns a GeoIP Anonymous IP model.
      *
      * @param string $ipAddress an IPv4 or IPv6 address as a string
      *
@@ -131,7 +131,7 @@ public function anonymousPlus(string $ipAddress): AnonymousPlus
     }
 
     /**
-     * This method returns a GeoLite2 ASN model.
+     * This method returns a GeoLite ASN model.
      *
      * @param string $ipAddress an IPv4 or IPv6 address as a string
      *
@@ -149,7 +149,7 @@ public function asn(string $ipAddress): Asn
     }
 
     /**
-     * This method returns a GeoIP2 Connection Type model.
+     * This method returns a GeoIP Connection Type model.
      *
      * @param string $ipAddress an IPv4 or IPv6 address as a string
      *
@@ -167,7 +167,7 @@ public function connectionType(string $ipAddress): ConnectionType
     }
 
     /**
-     * This method returns a GeoIP2 Domain model.
+     * This method returns a GeoIP Domain model.
      *
      * @param string $ipAddress an IPv4 or IPv6 address as a string
      *
@@ -185,7 +185,7 @@ public function domain(string $ipAddress): Domain
     }
 
     /**
-     * This method returns a GeoIP2 Enterprise model.
+     * This method returns a GeoIP Enterprise model.
      *
      * @param string $ipAddress an IPv4 or IPv6 address as a string
      *
@@ -199,7 +199,7 @@ public function enterprise(string $ipAddress): Enterprise
     }
 
     /**
-     * This method returns a GeoIP2 ISP model.
+     * This method returns a GeoIP ISP model.
      *
      * @param string $ipAddress an IPv4 or IPv6 address as a string
      *
@@ -283,7 +283,7 @@ public function metadata(): Metadata
     }
 
     /**
-     * Closes the GeoIP2 database and returns the resources to the system.
+     * Closes the GeoIP database and returns the resources to the system.
      */
     public function close(): void
     {
diff --git a/src/Exception/InvalidRequestException.php b/src/Exception/InvalidRequestException.php
@@ -5,7 +5,7 @@
 namespace GeoIp2\Exception;
 
 /**
- * This class represents an error returned by MaxMind's GeoIP2
+ * This class represents an error returned by MaxMind's GeoIP
  * web service.
  */
 class InvalidRequestException extends HttpException
diff --git a/src/Model/AnonymousIp.php b/src/Model/AnonymousIp.php
@@ -7,7 +7,7 @@
 use GeoIp2\Util;
 
 /**
- * This class provides the GeoIP2 Anonymous IP model.
+ * This class provides the GeoIP Anonymous IP model.
  */
 class AnonymousIp implements \JsonSerializable
 {
diff --git a/src/Model/Asn.php b/src/Model/Asn.php
@@ -7,7 +7,7 @@
 use GeoIp2\Util;
 
 /**
- * This class provides the GeoLite2 ASN model.
+ * This class provides the GeoLite ASN model.
  */
 class Asn implements \JsonSerializable
 {
diff --git a/src/Model/ConnectionType.php b/src/Model/ConnectionType.php
@@ -7,7 +7,7 @@
 use GeoIp2\Util;
 
 /**
- * This class provides the GeoIP2 Connection-Type model.
+ * This class provides the GeoIP Connection-Type model.
  */
 class ConnectionType implements \JsonSerializable
 {
diff --git a/src/Model/Country.php b/src/Model/Country.php
@@ -11,7 +11,7 @@
 use GeoIp2\Record\Traits;
 
 /**
- * Model class for the data returned by GeoIP2 Country web service and database.
+ * Model class for the data returned by GeoIP Country web service and database.
  *
  * See https://dev.maxmind.com/geoip/docs/web-services?lang=en for more details.
  */
diff --git a/src/Model/Domain.php b/src/Model/Domain.php
@@ -7,7 +7,7 @@
 use GeoIp2\Util;
 
 /**
- * This class provides the GeoIP2 Domain model.
+ * This class provides the GeoIP Domain model.
  */
 class Domain implements \JsonSerializable
 {
diff --git a/src/Model/Enterprise.php b/src/Model/Enterprise.php
@@ -5,7 +5,7 @@
 namespace GeoIp2\Model;
 
 /**
- * Model class for the data returned by GeoIP2 Enterprise database lookups.
+ * Model class for the data returned by GeoIP Enterprise database lookups.
  *
  * See https://dev.maxmind.com/geoip/docs/web-services?lang=en for more
  * details.
diff --git a/src/Model/Insights.php b/src/Model/Insights.php
@@ -7,7 +7,7 @@
 use GeoIp2\Record\Anonymizer;
 
 /**
- * Model class for the data returned by GeoIP2 Insights web service.
+ * Model class for the data returned by GeoIP Insights web service.
  *
  * See https://dev.maxmind.com/geoip/docs/web-services?lang=en for
  * more details.
diff --git a/src/Model/Isp.php b/src/Model/Isp.php
@@ -7,7 +7,7 @@
 use GeoIp2\Util;
 
 /**
- * This class provides the GeoIP2 ISP model.
+ * This class provides the GeoIP ISP model.
  */
 class Isp implements \JsonSerializable
 {
diff --git a/src/Record/AbstractPlaceRecord.php b/src/Record/AbstractPlaceRecord.php
@@ -9,7 +9,7 @@ abstract class AbstractPlaceRecord extends AbstractNamedRecord
     /**
      * @var int|null A value from 0-100 indicating MaxMind's
      *               confidence that the location level is correct. This attribute is only available
-     *               from the Insights service and the GeoIP2 Enterprise database.
+     *               from the Insights service and the GeoIP Enterprise database.
      */
     public readonly ?int $confidence;
 
diff --git a/src/Record/Anonymizer.php b/src/Record/Anonymizer.php
diff --git a/src/Record/Postal.php b/src/Record/Postal.php
diff --git a/src/Record/Traits.php b/src/Record/Traits.php
diff --git a/src/WebService/Client.php b/src/WebService/Client.php
diff --git a/tests/GeoIp2/Test/WebService/ClientTest.php b/tests/GeoIp2/Test/WebService/ClientTest.php

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "geoip2/geoip2",`
`3`		`- "description": "MaxMind GeoIP2 PHP API",`
	`3`	`+ "description": "MaxMind GeoIP PHP API",`
`4`	`4`	`"keywords": ["geoip", "geoip2", "geolocation", "ip", "maxmind"],`
`5`	`5`	`"homepage": "https://github.com/maxmind/GeoIP2-php",`
`6`	`6`	`"type": "library",`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-title = "MaxMind GeoIP2 PHP API"`
	`1`	`+title = "MaxMind GeoIP PHP API"`
`2`	`2`	`disableKinds = ["taxonomy", "term", "RSS"]`
`3`	`3`
`4`	`4`	`[[cascade]]`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`use MaxMind\Db\Reader\Metadata;`
`21`	`21`
`22`	`22`	`/**`
`23`		`- * Instances of this class provide a reader for the GeoIP2 database format.`
	`23`	`+ * Instances of this class provide a reader for the GeoIP database format.`
`24`	`24`	`* IP addresses can be looked up using the database specific methods.`
`25`	`25`	`*`
`26`	`26`	`* ## Usage ##`
`@@ -51,7 +51,7 @@ class Reader implements ProviderInterface`
`51`	`51`	`/**`
`52`	`52`	`* Constructor.`
`53`	`53`	`*`
`54`		`- * @param string $filename the path to the GeoIP2 database file`
	`54`	`+ * @param string $filename the path to the GeoIP database file`
`55`	`55`	`* @param array<string> $locales list of locale codes to use in name property`
`56`	`56`	`* from most preferred to least preferred`
`57`	`57`	`*`
`@@ -67,7 +67,7 @@ public function __construct(`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`/**`
`70`		`- * This method returns a GeoIP2 City model.`
	`70`	`+ * This method returns a GeoIP City model.`
`71`	`71`	`*`
`72`	`72`	`* @param string $ipAddress an IPv4 or IPv6 address as a string`
`73`	`73`	`*`
`@@ -81,7 +81,7 @@ public function city(string $ipAddress): City`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`/**`
`84`		`- * This method returns a GeoIP2 Country model.`
	`84`	`+ * This method returns a GeoIP Country model.`
`85`	`85`	`*`
`86`	`86`	`* @param string $ipAddress an IPv4 or IPv6 address as a string`
`87`	`87`	`*`
`@@ -95,7 +95,7 @@ public function country(string $ipAddress): Country`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`/**`
`98`		`- * This method returns a GeoIP2 Anonymous IP model.`
	`98`	`+ * This method returns a GeoIP Anonymous IP model.`
`99`	`99`	`*`
`100`	`100`	`* @param string $ipAddress an IPv4 or IPv6 address as a string`
`101`	`101`	`*`
`@@ -131,7 +131,7 @@ public function anonymousPlus(string $ipAddress): AnonymousPlus`
`131`	`131`	`}`
`132`	`132`
`133`	`133`	`/**`
`134`		`- * This method returns a GeoLite2 ASN model.`
	`134`	`+ * This method returns a GeoLite ASN model.`
`135`	`135`	`*`
`136`	`136`	`* @param string $ipAddress an IPv4 or IPv6 address as a string`
`137`	`137`	`*`
`@@ -149,7 +149,7 @@ public function asn(string $ipAddress): Asn`
`149`	`149`	`}`
`150`	`150`
`151`	`151`	`/**`
`152`		`- * This method returns a GeoIP2 Connection Type model.`
	`152`	`+ * This method returns a GeoIP Connection Type model.`
`153`	`153`	`*`
`154`	`154`	`* @param string $ipAddress an IPv4 or IPv6 address as a string`
`155`	`155`	`*`
`@@ -167,7 +167,7 @@ public function connectionType(string $ipAddress): ConnectionType`
`167`	`167`	`}`
`168`	`168`
`169`	`169`	`/**`
`170`		`- * This method returns a GeoIP2 Domain model.`
	`170`	`+ * This method returns a GeoIP Domain model.`
`171`	`171`	`*`
`172`	`172`	`* @param string $ipAddress an IPv4 or IPv6 address as a string`
`173`	`173`	`*`
`@@ -185,7 +185,7 @@ public function domain(string $ipAddress): Domain`
`185`	`185`	`}`
`186`	`186`
`187`	`187`	`/**`
`188`		`- * This method returns a GeoIP2 Enterprise model.`
	`188`	`+ * This method returns a GeoIP Enterprise model.`
`189`	`189`	`*`
`190`	`190`	`* @param string $ipAddress an IPv4 or IPv6 address as a string`
`191`	`191`	`*`
`@@ -199,7 +199,7 @@ public function enterprise(string $ipAddress): Enterprise`
`199`	`199`	`}`
`200`	`200`
`201`	`201`	`/**`
`202`		`- * This method returns a GeoIP2 ISP model.`
	`202`	`+ * This method returns a GeoIP ISP model.`
`203`	`203`	`*`
`204`	`204`	`* @param string $ipAddress an IPv4 or IPv6 address as a string`
`205`	`205`	`*`
`@@ -283,7 +283,7 @@ public function metadata(): Metadata`
`283`	`283`	`}`
`284`	`284`
`285`	`285`	`/**`
`286`		`- * Closes the GeoIP2 database and returns the resources to the system.`
	`286`	`+ * Closes the GeoIP database and returns the resources to the system.`
`287`	`287`	`*/`
`288`	`288`	`public function close(): void`
`289`	`289`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`use GeoIp2\Util;`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * This class provides the GeoIP2 Anonymous IP model.`
	`10`	`+ * This class provides the GeoIP Anonymous IP model.`
`11`	`11`	`*/`
`12`	`12`	`class AnonymousIp implements \JsonSerializable`
`13`	`13`	`{`