0 关注者

类 yii\helpers\IpHelper

所有类 | 方法 | 常量
继承关系yii\helpers\IpHelper » yii\helpers\BaseIpHelper
可用版本2.0.14
源代码 https://github.com/yiisoft/yii2/blob/master/framework/helpers/IpHelper.php

类 IpHelper 提供了一组与 IP 相关的静态方法。

方法期望输入正确的 IP 地址。要验证 IP 地址，请使用 IpValidator。

公共方法

隐藏继承的方法

方法 描述 定义于
expandIPv6() 将 IPv6 地址扩展为完整表示法。 yii\helpers\BaseIpHelper
getIpVersion() 获取 IP 版本。不执行 IP 地址验证。 yii\helpers\BaseIpHelper
inRange() 检查 IP 地址或子网 $subnet 是否包含在 $subnet 中。 yii\helpers\BaseIpHelper
ip2bin() 将 IP 地址转换为比特表示形式。 yii\helpers\BaseIpHelper

常量

隐藏继承的常量

常量 值 描述 定义于
IPV4 4 yii\helpers\BaseIpHelper
IPV4_ADDRESS_LENGTH 32 IPv4 地址的比特长度 yii\helpers\BaseIpHelper
IPV6 6 yii\helpers\BaseIpHelper
IPV6_ADDRESS_LENGTH 128 IPv6 地址的比特长度 yii\helpers\BaseIpHelper

方法详情

隐藏继承的方法

expandIPv6() 公共静态方法

定义于: yii\helpers\BaseIpHelper::expandIPv6()

将 IPv6 地址扩展为完整表示法。

例如 2001:db8::1 将扩展为 2001:0db8:0000:0000:0000:0000:0000:0001

public static string expandIPv6 ( $ip )
$ip 字符串

原始有效的 IPv6 地址
返回值 字符串

扩展后的 IPv6 地址

 

                public static function expandIPv6($ip)
{
    $hex = unpack('H*hex', inet_pton($ip));
    return substr(preg_replace('/([a-f0-9]{4})/i', '$1:', $hex['hex']), 0, -1);
}
getIpVersion() 公共静态方法

定义于: yii\helpers\BaseIpHelper::getIpVersion()

获取 IP 版本。不执行 IP 地址验证。

public static integer getIpVersion ( $ip )
$ip 字符串

有效的 IPv4 或 IPv6 地址。
返回值 整数

IPV4 或 IPV6

 

                public static function getIpVersion($ip)
{
    return strpos($ip, ':') === false ? self::IPV4 : self::IPV6;
}
inRange() 公共静态方法

定义于: yii\helpers\BaseIpHelper::inRange()

检查 IP 地址或子网 $subnet 是否包含在 $subnet 中。

例如，以下代码检查子网 192.168.1.0/24 是否在子网 192.168.0.0/22 中

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

如果您需要检查单个 IP 地址 192.168.1.21 是否在子网 192.168.1.0/24 中，您可以使用以下任一示例

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

另请参阅 https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing。

public static boolean inRange ( $subnet, $range )
$subnet 字符串

有效的 IPv4 或 IPv6 地址或 CIDR 范围，例如：10.0.0.0/8 或 2001:af::/64
$range 字符串

有效的 IPv4 或 IPv6 CIDR 范围，例如：10.0.0.0/8 或 2001:af::/64
返回值 布尔值

$subnet 是否包含在 $range 中
抛出 yii\base\NotSupportedException 

                public static function inRange($subnet, $range)
{
    list($ip, $mask) = array_pad(explode('/', $subnet), 2, null);
    list($net, $netMask) = array_pad(explode('/', $range), 2, null);
    $ipVersion = static::getIpVersion($ip);
    $netVersion = static::getIpVersion($net);
    if ($ipVersion !== $netVersion) {
        return false;
    }
    $maxMask = $ipVersion === self::IPV4 ? self::IPV4_ADDRESS_LENGTH : self::IPV6_ADDRESS_LENGTH;
    $mask = isset($mask) ? $mask : $maxMask;
    $netMask = isset($netMask) ? $netMask : $maxMask;
    $binIp = static::ip2bin($ip);
    $binNet = static::ip2bin($net);
    return substr($binIp, 0, $netMask) === substr($binNet, 0, $netMask) && $mask >= $netMask;
}
ip2bin() 公共静态方法

定义于: yii\helpers\BaseIpHelper::ip2bin()

将 IP 地址转换为比特表示形式。

public static string ip2bin ( $ip )
$ip 字符串

有效的 IPv4 或 IPv6 地址
返回值 字符串

比特字符串
抛出 yii\base\NotSupportedException 

                public static function ip2bin($ip)
{
    $ipBinary = null;
    if (static::getIpVersion($ip) === self::IPV4) {
        $ipBinary = pack('N', ip2long($ip));
    } elseif (@inet_pton('::1') === false) {
        throw new NotSupportedException('IPv6 is not supported by inet_pton()!');
    } else {
        $ipBinary = inet_pton($ip);
    }
    $result = '';
    for ($i = 0, $iMax = strlen($ipBinary); $i < $iMax; $i += 4) {
        $result .= str_pad(decbin(unpack('N', substr($ipBinary, $i, 4))[1]), 32, '0', STR_PAD_LEFT);
    }
    return $result;
}