ip2location/ip2proxy-cakephp

Allow users to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exit nodes, search engine robots, data center ranges and residential proxies.

1.1.2 2023-12-11 06:04 UTC

Requires

• php: >=5.4.0
• cakephp/cakephp: >=3.0
• ip2location/ip2proxy-php: >=3.0

Requires (Dev)

• phpunit/phpunit: ^9

MIT

• IP2Location

• geolocation
• cakephp
• proxy
• ip2proxy

README

IP2Proxy CakePHP plugin enables the user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exit nodes, search engine robots, data center ranges, residential proxies, consumer privacy networks, and enterprise private networks. It lookup the proxy IP address from IP2Proxy BIN Data file or web service. Developers can use the API to query all IP2Proxy BIN databases or web service for applications written using CakePHP.

INSTALLATION

For CakePHP 4.x

1. Run the command: composer require ip2location/ip2proxy-cakephp to download the plugin into the CakePHP 4 platform.
2. Download latest IP2Proxy BIN database
   • IP2Proxy free LITE database at https://lite.ip2location.com
   • IP2Proxy commercial database at https://www.ip2location.com/proxy-database
3. Unzip and copy the BIN file into cakephp/vendor/ip2location/ip2proxy-cakephp/src/Data folder.
4. Rename the BIN file to IP2PROXY.BIN.

Note: The plugin has included an old BIN database for your testing and development purpose. You may want to download a latest copy of BIN database as the URL stated above. The BIN database refers to the binary file ended with .BIN extension, but not the CSV format. Please select the right package for download.

USAGE

In this tutorial, we will show you on how to create a TestsController to display the IP information.

1. Create a TestsController in CakePHP 4 using the below command line

php bin/cake bake controller Tests

1. Create an empty index.php file in cakephp/templates/Tests folder.
2. Open the cakephp/src/Controller/TestsController.php in any text editor.
3. Remove the contents in TestsController.php and add the below lines into the controller file.

<?php
namespace App\Controller;

use App\Controller\AppController;
use IP2ProxyCakePHP\Controller\IP2ProxyCoresController;

// (required) Define IP2Location.io API key.
define('IP2LOCATION_IO_API_KEY', 'your_api_key');

// (optional) Define Translation information. Refer to https://www.ip2location.io/ip2location-documentation for available languages.
define('IP2LOCATION_IO_LANGUAGE', 'en');

/**
 * Tests Controller
 */
class TestsController extends AppController
{

    /**
     * Index method
     *
     * @return \Cake\Http\Response|void
     */
    public function index()
    {
        $IP2Proxy = new IP2ProxyCoresController();

        $record = $IP2Proxy->get('1.0.241.135');
        echo 'Result from BIN Database:<br>';
        echo '<p><strong>IP Address: </strong>' . $record['ipAddress'] . '</p>';
        echo '<p><strong>IP Number: </strong>' . $record['ipNumber'] . '</p>';
        echo '<p><strong>IP Version: </strong>' . $record['ipVersion'] . '</p>';
        echo '<p><strong>Country Code: </strong>' . $record['countryCode'] . '</p>';
        echo '<p><strong>Country: </strong>' . $record['countryName'] . '</p>';
        echo '<p><strong>State: </strong>' . $record['regionName'] . '</p>';
        echo '<p><strong>City: </strong>' . $record['cityName'] . '</p>';
        echo '<p><strong>Proxy Type: </strong>' . $record['proxyType'] . '</p>';
        echo '<p><strong>Is Proxy: </strong>' . $record['isProxy'] . '</p>';
        echo '<p><strong>ISP: </strong>' . $record['isp'] . '</p>';
        echo '<p><strong>Domain: </strong>' . $record['domain'] . '</p>';
        echo '<p><strong>Usage Type: </strong>' . $record['usageType'] . '</p>';
        echo '<p><strong>ASN: </strong>' . $record['asn'] . '</p>';
        echo '<p><strong>AS: </strong>' . $record['as'] . '</p>';
        echo '<p><strong>Last Seen: </strong>' . $record['lastSeen'] . '</p>';
        echo '<p><strong>Threat: </strong>' . $record['threat'] . '</p>';
        echo '<p><strong>Provider: </strong>' . $record['provider'] . '</p>';

        $record = $IP2Proxy->getWebService('1.0.241.135');
        echo 'Result from Web service:<br>';
        echo '<pre>';
        print_r ($record);
        echo '</pre>';
    }

}

1. Enter the URL /Tests and run. You should see the information of 1.0.241.135 IP address.

DEPENDENCIES

This library requires IP2Proxy BIN or IP2Proxy API key data file to function. You may download the BIN data file at

• IP2Proxy LITE BIN Data (Free): https://lite.ip2location.com
• IP2Proxy Commercial BIN Data (Comprehensive): https://www.ip2location.com/proxy-database

You can also sign up for IP2Location.io IP Geolocation API to get one free API key.

SUPPORT

Email: [e-mail]

Website: https://www.ip2location.com