josantonius/ip

This package is abandoned and no longer maintained. No replacement package was suggested.

PHP class to get user IP.

1.1.8 2022-07-30 19:01 UTC

Requires

• php: ^5.6 || ^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.3 || ^2.8
• phpmd/phpmd: ^2.6
• phpunit/phpunit: ^5.7 || ^6.0
• squizlabs/php_codesniffer: ^3.0

MIT

• Josantonius

• php
• IP
• hhvm
• REMOTE_ADDR
• Get user IP

README

Versión en español

PHP class to get user IP.

After reviewing the code after a few years, I would not recommend the use of the class for a production site, as preference was given to headers easily manipulated by the user to get the IP.

If the reliability of the header from which the IP will be obtained is not guaranteed, it is better to use $_SERVER['REMOTE_ADDR'] directly or develop a custom solution.

• Requirements
• Installation
• Available Methods
• Quick Start
• Usage
• Tests
• Sponsor
• License

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

Sponsor

If this project helps you to reduce your development time, you can sponsor me to support my open source work 😊

License

This repository is licensed under the MIT License.

Copyright © 2017-2022, Josantonius