PHP Classes
elePHPant
Icontem

PHP-Ip: Get the real user IP address even behind proxies

Recommend this page to a friend!
  Info   View files Documentation   View files View files (14)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2017-12-06 (1 month ago) RSS 2.0 feedNot enough user ratingsTotal: 172 This week: 1All time: 8,287 This week: 631Up
Version License PHP version Categories
php-ip 1.1.5MIT/X Consortium ...5.6Networking, PHP 5
Description Author

This class can get the real user IP address even behind proxies.

It can check the environment variables set by PHP from the incoming HTTP request to determine the real user IP address.

The class can also perform validation of the IP address to avoid spoofing.

  Performance   Level  
Name: Josantonius is available for providing paid consulting. Contact Josantonius .
Classes: 20 packages by
Country: Spain Spain
Age: ???
All time rank: 209048 in Spain Spain
Week rank: 20 Up1 in Spain Spain Up
Innovation award
Innovation award
Nominee: 9x

Details

PHP Ip library

Latest Stable Version Latest Unstable Version License Codacy Badge Total Downloads Travis PSR2 PSR4 CodeCov

Versión en español

PHP class to get user IP.

Requirements

This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.

Installation

The preferred way to install this extension is through Composer.

To install PHP Ip library, simply:

$ composer require Josantonius/Ip

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

$ composer require Josantonius/Ip --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/Josantonius/PHP-Ip.git

Or install it manually:

Download Ip.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-Ip/master/src/Ip.php

Available Methods

Available methods in this library:

- Get user's IP:

Ip::get();

# Return (string|false) ? user IP or false

- Validate IP:

Ip::validate($ip);

| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $ip | IP address to be validated. | string | Yes | |

# Return (boolean)

Quick Start

To use this library with Composer:

require __DIR__ . '/vendor/autoload.php';

use Josantonius\Ip\Ip;

Or If you installed it manually, use it:

require_once __DIR__ . '/Ip.php';

use Josantonius\Ip\Ip;

Usage

Example of use for this library:

- Get user's IP:

Ip::get();

- Validate IP:

$ip = Ip::get();

Ip::validate($ip);

Tests

To run tests you just need composer and to execute the following:

$ git clone https://github.com/Josantonius/PHP-Ip.git

$ cd PHP-Ip

$ composer install

Run unit tests with PHPUnit:

$ composer phpunit

Run PSR2 code standard tests with PHPCS:

$ composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:

$ composer phpmd

Run all previous tests:

$ composer tests

? TODO

  • [ ] Add new feature
  • [ ] Improve tests
  • [ ] Improve documentation
  • [ ] Refactor code

Contribute

If you would like to help, please take a look at the list of issues or the To Do checklist.

Pull requests

  • Fork and clone.
  • Run the command composer install to install the dependencies. This will also install the dev dependencies.
  • Run the command composer fix to excute code standard fixers.
  • Run the tests.
  • Create a branch, commit, push and send me a pull request.

Repository

The file structure from this repository was created with PHP-Skeleton.

License

This project is licensed under MIT license. See the LICENSE file for more info.

Copyright

2017 Josantonius, josantonius.com

If you find it useful, let me know :wink:

You can contact me on Twitter or through my email.

  Files folder image Files  
File Role Description
Files folder imagesrc (1 file)
Files folder imagetests (1 file)
Accessible without login Plain text file .editorconfig Data Auxiliary data
Accessible without login Plain text file .php_cs.dist Example Example script
Accessible without login Plain text file .travis.yml Data Auxiliary data
Accessible without login Plain text file CHANGELOG.md Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file CONDUCT.md Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file phpcs.xml Data Auxiliary data
Accessible without login Plain text file phpmd.xml Data Auxiliary data
Accessible without login Plain text file phpunit.xml Data Auxiliary data
Accessible without login Plain text file README-ES.md Doc. Documentation
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  src  
File Role Description
  Plain text file Ip.php Class Class source

  Files folder image Files  /  tests  
File Role Description
  Plain text file IpTest.php Class Class source

 Version Control Reuses Unique User Downloads Download Rankings  
 100%1
Total:172
This week:1
All time:8,287
This week:631Up