README

A simple PHP library to get your public IP address reliably and fast.

This library uses dig or HTTP requests to obtain the public IP address of the current machine by utilizing publicly available whoami services.

It comes with an opinionated default configuration to use the fastest and most reliable fetchers and providers. However, it also includes a flexible API that allows you to use different fetchers and different providers.

🚀 Installation

composer require knotsphp/publicip

📚 Usage

Easiest way to get the public IP address of the current machine is to use the PublicIP::get() method.

use KnotsPHP\PublicIP\Finders\{ PublicIP, PublicIPv4, PublicIPv6 };

$ipv4 = PublicIPv4::get(); // returns your IPv4
$ipv6 = PublicIPv6::get(); // returns your IPv6
$ipv4or6 = PublicIP::get(); // returns either IPv4 or IPv6

These methods return the IP address as a string or null if the fetcher fails. No exceptions are thrown.

If you want to use a specific fetcher, or a specific provider, you can use the PublicIPv4::finder()->fetch() method.

use KnotsPHP\PublicIP\Enums\DnsProvider;
use KnotsPHP\PublicIP\Fetchers\DigFetcher;
use KnotsPHP\PublicIP\Finders\PublicIPv4;

$ipv4 = PublicIPv4::finder()
    ->addFetcher((new DigFetcher())
        ->from(DnsProvider::OpenDNS)))
    ->fetch();

This method gives you more control, but you will need to manage exceptions on your own.

Advanced Usage

You can also use a Fetcher directly to get the IP address.

use KnotsPHP\PublicIP\Enums\DnsProvider;
use KnotsPHP\PublicIP\Enums\IpVersion;
use KnotsPHP\PublicIP\Fetchers\DigFetcher;

$ipv4 = (new DigFetcher)->from(DnsProvider::Cloudflare)->fetch(IpVersion::v4);

Note that this returns null instead of throwing an exception if the fetcher fails.

📚 Use in command line

You can also use this library in the command line by using the publicip command.

It's recommended to install the library globally to use it in the command line.

composer global require knotsphp/publicip

Then you can use the publicip command to get the public IP address of the current machine.

# In your project directory
vendor/bin/publicip

# Globally installed
publicip

# To get the IPv4 address
publicip --ipv4
publicip -4

# To get the IPv6 address
publicip --ipv6
publicip -6

🏃 Performance

If you are sure that your machine has dig installed, you can speed up the process by setting the isSupported property to true.

It works both ways; if you are sure that your machine does not have dig installed, you can set it to false to prevent unnecessary checks.

use KnotsPHP\PublicIP\Fetcher\DigFetcher;

DigFetcher::$isSupported = true;

If you use the CurlFetcher or FileGetContentsFetcher, you can set the forceHTTP property to true to use HTTP instead of HTTPS. Some whoami services do not support HTTPS anyway as they are meant to be used in scripts like this curl ifconfig.co.

use KnotsPHP\PublicIP\Fetcher\CurlFetcher;
use KnotsPHP\PublicIP\Fetchers\FileGetContentsFetcher;

CurlFetcher::$forceHTTP = true;
FileGetContentsFetcher::$forceHTTP = true;

📖 Documentation

dig provider list

HTTP whoami provider list

📋 TODO

Contributions are welcome!

use Symfony ExecutableFinder to find dig
use Symfony Process to run dig
PSR-18 HTTP fetcher with a way to choose psr compatible client so other tools can monitor outgoing requests

🤝 Contributing

Clone the project and run composer update to install the dependencies.

Before pushing your changes, run composer qa.

This will run pint (code style), phpstan (static analysis), and pest (tests).

📦 Alternatives

If you are not pleased with this library, check out the following alternatives:

https://github.com/martinlindhe/php-myip

You can also contribute to this library by opening an issue or a pull request.

👥 Credits

PublicIP was created by Eser DENIZ.

📝 License

PublicIP is licensed under the MIT License. See LICENSE for more information.

knotsphp / publicip

Maintainers

Details