BaseIpHelper

API reference › yii › helpers › BaseIpHelper

class	`yii\helpers\BaseIpHelper`
Since	2.0.14
Source	`framework/helpers/BaseIpHelper.php`

1 subclass

Class BaseIpHelper provides concrete implementation for IpHelper

Do not use BaseIpHelper, use IpHelper instead.

Methods

Method	Description	Defined by
`expandIPv6()` static	Expands an IPv6 address to it’s full notation.	`BaseIpHelper`
`getIpVersion()` static	Gets the IP version. Does not perform IP address validation.	`BaseIpHelper`
`inRange()` static	Checks whether IP address or subnet $subnet is contained by $subnet.	`BaseIpHelper`
`ip2bin()` static	Converts IP address to bits representation.	`BaseIpHelper`

Constant	Value	Description	Defined by
`IPV4`	`4`		`BaseIpHelper`
`IPV6`	`6`		`BaseIpHelper`
`IPV6_ADDRESS_LENGTH`	`128`	The length of IPv6 address in bits	`BaseIpHelper`
`IPV4_ADDRESS_LENGTH`	`32`	The length of IPv4 address in bits	`BaseIpHelper`

public static function expandIPv6(string $ip): string

Expands an IPv6 address to it’s full notation.

For example 2001:db8::1 will be expanded to 2001:0db8:0000:0000:0000:0000:0000:0001

Parameters

Parameter	Type	Description
`$ip`	`string`	The original valid IPv6 address

Returns

string: The expanded IPv6 address

public static function getIpVersion(string $ip): int

Gets the IP version. Does not perform IP address validation.

Parameters

Parameter	Type	Description
`$ip`	`string`	The valid IPv4 or IPv6 address.

Returns

int: IPV4 or IPV6

public static function inRange(string $subnet, string $range): bool

Checks whether IP address or subnet $subnet is contained by $subnet.

For example, the following code checks whether subnet 192.168.1.0/24 is in subnet 192.168.0.0/22:

IpHelper::inRange('192.168.1.0/24', '192.168.0.0/22'); // true

In case you need to check whether a single IP address 192.168.1.21 is in the subnet 192.168.1.0/24, you can use any of theses examples:

IpHelper::inRange('192.168.1.21', '192.168.1.0/24'); // true
IpHelper::inRange('192.168.1.21/32', '192.168.1.0/24'); // true

Parameters

Parameter	Type	Description
`$subnet`	`string`	The valid IPv4 or IPv6 address or CIDR range, e.g.: `10.0.0.0/8` or `2001:af::/64`
`$range`	`string`	The valid IPv4 or IPv6 CIDR range, e.g. `10.0.0.0/8` or `2001:af::/64`

Returns

bool: Whether $subnet is contained by $range

Throws

See also

public static function ip2bin(string $ip): string

Converts IP address to bits representation.

Parameters

Parameter	Type	Description
`$ip`	`string`	The valid IPv4 or IPv6 address

Returns

string: Bits as a string

Throws