A collection of public static functions to play with IP address and IP blocks.
More...
|
static | canonicalize ( $addr) |
| Convert some unusual representations of IPv4 addresses to their canonical dotted quad representation.
|
|
static | combineHostAndPort ( $host, $port, $defaultPort=false) |
| Given a host name and a port, combine them into host/port string like you might find in a URL.
|
|
static | formatHex ( $hex) |
| Convert an IPv4 or IPv6 hexadecimal representation back to readable format.
|
|
static | getSubnet ( $ip) |
| Returns the subnet of a given IP.
|
|
static | hexToOctet ( $ip_hex) |
| Converts a hexadecimal number to an IPv6 address in octet notation.
|
|
static | hexToQuad ( $ip_hex) |
| Converts a hexadecimal number to an IPv4 address in quad-dotted notation.
|
|
static | isInRange ( $addr, $range) |
| Determine if a given IPv4/IPv6 address is in a given CIDR network.
|
|
static | isInRanges ( $ip, $ranges) |
| Determines if an IP address is a list of CIDR a.b.c.d/n ranges.
|
|
static | isIPAddress ( $ip) |
| Determine if a string is as valid IP address or network (CIDR prefix).
|
|
static | isIPv4 ( $ip) |
| Given a string, determine if it as valid IP in IPv4 only.
|
|
static | isIPv6 ( $ip) |
| Given a string, determine if it as valid IP in IPv6 only.
|
|
static | isPublic ( $ip) |
| Determine if an IP address really is an IP address, and if it is public, i.e.
|
|
static | isValid ( $ip) |
| Validate an IP address.
|
|
static | isValidBlock ( $ipblock) |
| Validate an IP Block (valid address WITH a valid prefix).
|
|
static | parseCIDR ( $range) |
| Convert a network specification in CIDR notation to an integer network and a number of bits.
|
|
static | parseRange ( $range) |
| Given a string range in a number of formats, return the start and end of the range in hexadecimal.
|
|
static | prettifyIP ( $ip) |
| Prettify an IP for display to end users.
|
|
static | sanitizeIP ( $ip) |
| Convert an IP into a verbose, uppercase, normalized form.
|
|
static | sanitizeRange ( $range) |
| Gets rid of unneeded numbers in quad-dotted/octet IP strings For example, 127.111.113.151/24 -> 127.111.113.0/24.
|
|
static | splitHostAndPort ( $both) |
| Given a host/port string, like one might find in the host part of a URL per RFC 2732, split the hostname part and the port part and return an array with an element for each.
|
|
static | toHex ( $ip) |
| Return a zero-padded upper case hexadecimal representation of an IP address.
|
|
|
static | IPv6ToRawHex ( $ip) |
| Given an IPv6 address in octet notation, returns a pure hex string.
|
|
static | parseCIDR6 ( $range) |
| Convert a network specification in IPv6 CIDR notation to an integer network and a number of bits.
|
|
static | parseRange6 ( $range) |
| Given a string range in a number of formats, return the start and end of the range in hexadecimal.
|
|
A collection of public static functions to play with IP address and IP blocks.
Definition at line 67 of file IP.php.
◆ canonicalize()
static IP::canonicalize |
( |
|
$addr | ) |
|
|
static |
Convert some unusual representations of IPv4 addresses to their canonical dotted quad representation.
This currently only checks a few IPV4-to-IPv6 related cases. More unusual representations may be added later.
- Parameters
-
string | $addr | Something that might be an IP address |
- Returns
- string|null Valid dotted quad IPv4 address or null
Definition at line 675 of file IP.php.
◆ combineHostAndPort()
static IP::combineHostAndPort |
( |
|
$host, |
|
|
|
$port, |
|
|
|
$defaultPort = false |
|
) |
| |
|
static |
Given a host name and a port, combine them into host/port string like you might find in a URL.
If the host contains a colon, wrap it in square brackets like in RFC 2732. If the port matches the default port, omit the port specification
- Parameters
-
string | $host | |
int | $port | |
bool | int | $defaultPort | |
- Returns
- string
Definition at line 303 of file IP.php.
◆ formatHex()
static IP::formatHex |
( |
|
$hex | ) |
|
|
static |
Convert an IPv4 or IPv6 hexadecimal representation back to readable format.
- Parameters
-
string | $hex | Number, with "v6-" prefix if it is IPv6 |
- Returns
- string Quad-dotted (IPv4) or octet notation (IPv6)
Definition at line 320 of file IP.php.
◆ getSubnet()
static IP::getSubnet |
( |
|
$ip | ) |
|
|
static |
Returns the subnet of a given IP.
- Parameters
-
- Returns
- string|false
Definition at line 730 of file IP.php.
◆ hexToOctet()
static IP::hexToOctet |
( |
|
$ip_hex | ) |
|
|
static |
Converts a hexadecimal number to an IPv6 address in octet notation.
- Parameters
-
string | $ip_hex | Pure hex (no v6- prefix) |
- Returns
- string (of format a:b:c:d:e:f:g:h)
Definition at line 334 of file IP.php.
◆ hexToQuad()
static IP::hexToQuad |
( |
|
$ip_hex | ) |
|
|
static |
Converts a hexadecimal number to an IPv4 address in quad-dotted notation.
- Parameters
-
- Returns
- string (of format a.b.c.d)
Definition at line 354 of file IP.php.
◆ IPv6ToRawHex()
static IP::IPv6ToRawHex |
( |
|
$ip | ) |
|
|
staticprivate |
Given an IPv6 address in octet notation, returns a pure hex string.
- Parameters
-
string | $ip | Octet ipv6 IP address. |
- Returns
- string|bool Pure hex (uppercase); false on failure
Definition at line 438 of file IP.php.
◆ isInRange()
static IP::isInRange |
( |
|
$addr, |
|
|
|
$range |
|
) |
| |
|
static |
Determine if a given IPv4/IPv6 address is in a given CIDR network.
- Parameters
-
string | $addr | The address to check against the given range. |
string | $range | The range to check the given address against. |
- Returns
- bool Whether or not the given address is in the given range.
- Note
- This can return unexpected results for invalid arguments! Make sure you pass a valid IP address and IP range.
Definition at line 638 of file IP.php.
◆ isInRanges()
static IP::isInRanges |
( |
|
$ip, |
|
|
|
$ranges |
|
) |
| |
|
static |
Determines if an IP address is a list of CIDR a.b.c.d/n ranges.
- Since
- 1.25
- Parameters
-
string | $ip | the IP to check |
array | $ranges | the IP ranges, each element a range |
- Returns
- bool true if the specified adress belongs to the specified range; otherwise, false.
Definition at line 656 of file IP.php.
◆ isIPAddress()
static IP::isIPAddress |
( |
|
$ip | ) |
|
|
static |
Determine if a string is as valid IP address or network (CIDR prefix).
SIIT IPv4-translated addresses are rejected.
- Note
- canonicalize() tries to convert translated addresses to IPv4.
- Parameters
-
string | $ip | Possible IP address |
- Returns
- bool
Definition at line 79 of file IP.php.
◆ isIPv4()
Given a string, determine if it as valid IP in IPv4 only.
- Note
- Unlike isValid(), this looks for networks too.
- Parameters
-
string | $ip | Possible IP address |
- Returns
- bool
Definition at line 101 of file IP.php.
◆ isIPv6()
Given a string, determine if it as valid IP in IPv6 only.
- Note
- Unlike isValid(), this looks for networks too.
- Parameters
-
string | $ip | Possible IP address |
- Returns
- bool
Definition at line 90 of file IP.php.
◆ isPublic()
static IP::isPublic |
( |
|
$ip | ) |
|
|
static |
Determine if an IP address really is an IP address, and if it is public, i.e.
not RFC 1918 or similar
- Parameters
-
- Returns
- bool
Definition at line 376 of file IP.php.
◆ isValid()
static IP::isValid |
( |
|
$ip | ) |
|
|
static |
Validate an IP address.
Ranges are NOT considered valid. SIIT IPv4-translated addresses are rejected.
- Note
- canonicalize() tries to convert translated addresses to IPv4.
- Parameters
-
- Returns
- bool True if it is valid
Definition at line 113 of file IP.php.
◆ isValidBlock()
static IP::isValidBlock |
( |
|
$ipblock | ) |
|
|
static |
Validate an IP Block (valid address WITH a valid prefix).
SIIT IPv4-translated addresses are rejected.
- Note
- canonicalize() tries to convert translated addresses to IPv4.
- Parameters
-
- Returns
- bool True if it is valid
Definition at line 126 of file IP.php.
◆ parseCIDR()
static IP::parseCIDR |
( |
|
$range | ) |
|
|
static |
Convert a network specification in CIDR notation to an integer network and a number of bits.
- Parameters
-
string | $range | IP with CIDR prefix |
- Returns
- array(int or string, int)
Definition at line 458 of file IP.php.
◆ parseCIDR6()
static IP::parseCIDR6 |
( |
|
$range | ) |
|
|
staticprivate |
Convert a network specification in IPv6 CIDR notation to an integer network and a number of bits.
- Parameters
-
- Returns
- array(string, int)
Definition at line 548 of file IP.php.
◆ parseRange()
static IP::parseRange |
( |
|
$range | ) |
|
|
static |
Given a string range in a number of formats, return the start and end of the range in hexadecimal.
Formats are: 1.2.3.4/24 CIDR 1.2.3.4 - 1.2.3.5 Explicit range 1.2.3.4 Single IP
2001:0db8:85a3::7344/96 CIDR 2001:0db8:85a3::7344 - 2001:0db8:85a3::7344 Explicit range 2001:0db8:85a3::7344 Single IP
- Parameters
-
- Returns
- array(string, string)
Definition at line 501 of file IP.php.
◆ parseRange6()
static IP::parseRange6 |
( |
|
$range | ) |
|
|
staticprivate |
Given a string range in a number of formats, return the start and end of the range in hexadecimal.
For IPv6.
Formats are: 2001:0db8:85a3::7344/96 CIDR 2001:0db8:85a3::7344 - 2001:0db8:85a3::7344 Explicit range 2001:0db8:85a3::7344/96 Single IP
- Parameters
-
- Returns
- array(string, string)
Definition at line 589 of file IP.php.
◆ prettifyIP()
static IP::prettifyIP |
( |
|
$ip | ) |
|
|
static |
Prettify an IP for display to end users.
This will make it more compact and lower-case.
- Parameters
-
- Returns
- string
Definition at line 201 of file IP.php.
◆ sanitizeIP()
static IP::sanitizeIP |
( |
|
$ip | ) |
|
|
static |
Convert an IP into a verbose, uppercase, normalized form.
Both IPv4 and IPv6 addresses are trimmed. Additionally, IPv6 addresses in octet notation are expanded to 8 words; IPv4 addresses have leading zeros, in each octet, removed.
- Parameters
-
string | $ip | IP address in quad or octet form (CIDR or not). |
- Returns
- string
Definition at line 140 of file IP.php.
◆ sanitizeRange()
static IP::sanitizeRange |
( |
|
$range | ) |
|
|
static |
Gets rid of unneeded numbers in quad-dotted/octet IP strings For example, 127.111.113.151/24 -> 127.111.113.0/24.
- Parameters
-
string | $range | IP address to normalize |
- Returns
- string
Definition at line 713 of file IP.php.
◆ splitHostAndPort()
static IP::splitHostAndPort |
( |
|
$both | ) |
|
|
static |
Given a host/port string, like one might find in the host part of a URL per RFC 2732, split the hostname part and the port part and return an array with an element for each.
If there is no port part, the array will have false in place of the port. If the string was invalid in some way, false is returned.
This was easy with IPv4 and was generally done in an ad-hoc way, but with IPv6 it's somewhat more complicated due to the need to parse the square brackets and colons.
A bare IPv6 address is accepted despite the lack of square brackets.
- Parameters
-
string | $both | The string with the host and port |
- Returns
- array|false Array normally, false on certain failures
Definition at line 254 of file IP.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqli\mysqlConnect().
◆ toHex()
Return a zero-padded upper case hexadecimal representation of an IP address.
Hexadecimal addresses are used because they can easily be extended to IPv6 support. To separate the ranges, the return value from this function for an IPv6 address will be prefixed with "v6-", a non- hexadecimal string which sorts after the IPv4 addresses.
- Parameters
-
string | $ip | Quad dotted/octet IP address. |
- Returns
- string|bool False on failure
Definition at line 405 of file IP.php.
◆ $proxyIpSet
IPSet IP::$proxyIpSet = null |
|
staticprivate |
The documentation for this class was generated from the following file: