benjamin-smith/php-ipify

PHP client library for ipify: A Simple IP Address API.

1.0.0 2016-03-15 02:26 UTC

This package is not auto-updated.

Last update: 2024-10-26 17:24:26 UTC


README

Software License Build Status Quality Score Total Downloads

This library will retrieve your public IP address from ipify's API service, and return it as a string.

This library also has some other nice features you might care about:

  • This library handles exceptions properly, and usage examples below show you how to deal with errors in a foolproof way.
  • This library only makes API requests over HTTPS.

Install

Via Composer

$ composer require benjamin-smith/php-ipify

Usage

echo Ipify\Ip::get();

Or, if your inclined to catch any errors:

try {
    $ip = Ipify\Ip::get();    
} catch (ConnectionError $e) {
    // If you get here, it means you were unable to reach the ipify service,
    // most likely because of a network error on your end.
} catch (ServiceError $e) {
    // If you get here, it means ipify is having issues, so the request
    // couldn't be completed :(
} catch (Exception $e) {
    // Something else happened (non-ipify related).
}

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email ben@benjaminsmith.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.