File: README.md

Recommend this page to a friend!

README.md

File:	`README.md`
Role:	Documentation
Content type:	`text/markdown`
Description:	Documentation
Class:	PHP-Ip Get the real user IP address even behind proxies
Author:	By Josantonius
Last change:	Updated to 1.1.7 version Updated to 1.1.7 version Updated to 1.1.7 version Updated to 1.1.7 version
Date:	6 years ago
Size:	`5,312 bytes`

PHP Ip library

PHP class to get user IP.

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

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:

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

Available methods in this library:

Ip::get();

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

Ip::validate($ip);

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

# Return (boolean)

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;

Example of use for this library:

Ip::get();

$ip = Ip::get();

Ip::validate($ip);

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

[ ] Add new feature.
[ ] Improve tests.
[ ] Improve documentation.
[ ] Refactor code for disabled code style rules. See phpmd.xml and .php_cs.dist.

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.