Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cs-eliseev/helpers-ip
The helpers allows you to manipulating network IP addresses (IPv4 and IPv6).
https://github.com/cs-eliseev/helpers-ip
collection collections cse framework helper helpers ip ips ips4 ipv4 ipv6 library network networking php tool tools utilities utility utils
Last synced: 11 days ago
JSON representation
The helpers allows you to manipulating network IP addresses (IPv4 and IPv6).
- Host: GitHub
- URL: https://github.com/cs-eliseev/helpers-ip
- Owner: cs-eliseev
- License: mit
- Created: 2019-02-16T05:12:48.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-04-27T07:25:09.000Z (over 5 years ago)
- Last Synced: 2024-04-03T23:03:17.075Z (9 months ago)
- Topics: collection, collections, cse, framework, helper, helpers, ip, ips, ips4, ipv4, ipv6, library, network, networking, php, tool, tools, utilities, utility, utils
- Language: PHP
- Size: 57.6 KB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
English | [Русский](https://github.com/cs-eliseev/helpers-ip/blob/master/README.ru_RU.md)
IP CSE HELPERS
=======
[](https://travis-ci.org/cs-eliseev/helpers-ip)
[](https://codecov.io/gh/cs-eliseev/helpers-ip)
[](https://scrutinizer-ci.com/g/cs-eliseev/helpers-ip/?branch=master)
[](https://packagist.org/packages/cse/helpers-ip)
[](https://packagist.org/packages/cse/helpers-ip)
[](https://github.com/cs-eliseev/helpers-ip/blob/master/LICENSE.md)
[](https://github.com/cs-eliseev/helpers-ip/archive/master.zip)
The helpers allows you to manipulating network IP addresses (IPv4 and IPv6).
Project repository: https://github.com/cs-eliseev/helpers-ip
**DEMO**
```php
$ip = IP::getRealIP();
if (IP::isIP($ip)) {
switch (true) {
case IP::isIPv4($ip):
break;
case IP::isIPv6($ip):
$ip = IP::removeSubnetMaskIPv6($ip);
$ip = IP::getRangeIPv6($ip);
$ip = IP::getFirstIPByVersion($ip);
break;
}
$version = IP::getVersionIP($ip);
}
```
***
## Introduction
[CSE HELPERS](https://github.com/cs-eliseev/helpers/blob/master/README.md) is a collection of several libraries with simple functions written in PHP for people.
Despite using PHP as the main programming language for the Internet, its functions are not enough. IP CSE HELPERS for manipulating network IP addresses (IPv4 and IPv6).
[CSE HELPERS](https://github.com/cs-eliseev/helpers/blob/master/README.md) was created for the rapid development of web applications.
**CSE Helpers project:**
* [Array CSE helpers](https://github.com/cs-eliseev/helpers-arrays)
* [Cookie CSE helpers](https://github.com/cs-eliseev/helpers-cookie)
* [Date CSE helpers](https://github.com/cs-eliseev/helpers-date)
* [Email CSE helpers](https://github.com/cs-eliseev/helpers-email)
* [IP CSE helpers](https://github.com/cs-eliseev/helpers-ip)
* [Json CSE helpers](https://github.com/cs-eliseev/helpers-json)
* [Math Converter CSE helpers](https://github.com/cs-eliseev/helpers-math-converter)
* [Phone CSE helpers](https://github.com/cs-eliseev/helpers-phone)
* [Request CSE helpers](https://github.com/cs-eliseev/helpers-request)
* [Session CSE helpers](https://github.com/cs-eliseev/helpers-session)
* [Word CSE helpers](https://github.com/cs-eliseev/helpers-word)
Below you will find some information on how to init library and perform common commands.
## Install
You can find the most recent version of this project [here](https://github.com/cs-eliseev/helpers-ip).
### Composer
Execute the following command to get the latest version of the package:
```bash
composer require cse/helpers-ip
```
Or file composer.json should include the following contents:
```json
{
"require": {
"cse/helpers-ip": "*"
}
}
```
### Git
Clone this repository locally:
```bash
git clone https://github.com/cs-eliseev/helpers-ip.git
```
### Download
[Download the latest release here](https://github.com/cs-eliseev/helpers-ip/archive/master.zip).
## Usage
The class consists of static methods that are conveniently used in any project. See example [examples-ip.php](https://github.com/cs-eliseev/helpers-ip/blob/master/examples/examples-ip.php).
**Get real IP address**
Example:
```php
IP::getRealIP();
// xxx.xxx.xxx.xxx
```
**Remove subnet mask IPv6**
Example:
```php
IP::removeSubnetMaskIPv6('2a0a:2b40::4:60/124');
// 2a0a:2b40::4:60
```
**Check is IPv4 address**
Example:
```php
IP::isIPv4('127.0.0.1');
// true
```
Check is IPv6:
```php
IP::isIPv4('2a0a:2b40::4:60');
// false
```
Check is not IP:
```php
IP::isIPv4('256.256.256');
// false
```
**Check is IPv6 address**
Example:
```php
IP::isIPv6('2a0a:2b40::4:60');
// true
```
Check null:
```php
IP::isIPv6('::');
// true
```
Check localhost IPv6:
```php
IP::isIPv6('::1');
// true
IP::isIPv6('0:0:0:0:0:0:0:1');
// true
```
Check is IPv4:
```php
IP::isIPv6('127.0.0.1');
// false
```
Check is not IP:
```php
IP::isIPv6(':');
// false
```
**Get version IP address**
Example:
```php
IP::getVersionIP('::1');
// 6
```
Get versin IPv4:
```php
IP::getVersionIP('127.0.0.1');
// 4
```
Get versin IPv6:
```php
IP::getVersionIP('0:0:0:0:0:0:0:1');
// 6
```
Get versin in not IP:
```php
IP::getVersionIP('256.256.256.256');
// null
```
**Is IP address**
Example:
```php
IP::isIP('::1');
// true
```
Check versin IPv4:
```php
IP::isIP('127.0.0.1');
// true
```
Check versin IPv6:
```php
IP::isIP('0:0:0:0:0:0:0:1');
// true
```
Check versin in not IP:
```php
IP::isIP('256.256.256.256');
// false
```
**Get range IPv6 address**
Example:
```php
IP::getRangeIPv6('2a0a:2b40::4:60/124');
// ['2a0a:2b40::4:60', '2a0a:2b40::4:6f']
```
**Filter IPs address**
Example:
```php
IP::filterIPs([
'127.0.0.1',
'2a0a:2b40::4:60',
'255.255.255.255',
'2a0a:2b40::4:6f',
'256.256.256.256'
]);
// [4 => ['127.0.0.1', '255.255.255.255'], 6 => ['2a0a:2b40::4:60', '2a0a:2b40::4:6f']]
```
Not data IP version:
```php
IP::filterIPs([
'127.0.0.1',
'255.255.255.255',
'256.256.256.256'
]);
// [4 => ['127.0.0.1', '255.255.255.255'], 6 => []]
```
Filter IPv4 address:
```php
IP::filterIPs([
'127.0.0.1',
'2a0a:2b40::4:60',
'255.255.255.255',
'2a0a:2b40::4:6f',
'256.256.256.256'
], 4);
// ['127.0.0.1', '255.255.255.255']
```
Filter IPv6 address:
```php
IP::filterIPs([
'127.0.0.1',
'2a0a:2b40::4:60',
'255.255.255.255',
'2a0a:2b40::4:6f',
'256.256.256.256'
], 6);
// ['2a0a:2b40::4:60', '2a0a:2b40::4:6f']
```
**Get first IP by version**
Example:
```php
IP::getFirstIPByVersion([
'256.256.256.256',
'127.0.0.1',
'2a0a:2b40::4:60',
'255.255.255.255',
'2a0a:2b40::4:6f',
'256.256.256.256'
], 4);
// '127.0.0.1'
```
Get first IP by version 6:
```php
IP::getFirstIPByVersion([
'256.256.256.256',
'127.0.0.1',
'2a0a:2b40::4:60',
'255.255.255.255',
'2a0a:2b40::4:6f'
], 6);
// '2a0a:2b40::4:60'
```
## Testing & Code Coverage
PHPUnit is used for unit testing. Unit tests ensure that class and methods does exactly what it is meant to do.
General PHPUnit documentation can be found at https://phpunit.de/documentation.html.
To run the PHPUnit unit tests, execute:
```bash
phpunit PATH/TO/PROJECT/tests/
```
If you want code coverage reports, use the following:
```bash
phpunit --coverage-html ./report PATH/TO/PROJECT/tests/
```
Used PHPUnit default config:
```bash
phpunit --configuration PATH/TO/PROJECT/phpunit.xml
```
## Donating
You can support this project [here](https://www.paypal.me/cseliseev/10usd).
You can also help out by contributing to the project, or reporting bugs.
Even voicing your suggestions for features is great. Anything to help is much appreciated.
## License
The IP CSE HELPERS is open-source PHP library licensed under the MIT license. Please see [License File](https://github.com/cs-eliseev/helpers-ip/blob/master/LICENSE.md) for more information.
***
> GitHub [@cs-eliseev](https://github.com/cs-eliseev)