|
| 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 ( $ipRange) |
| | Validate an IP range (valid address with a valid CIDR prefix).
|
| |
| static | isValidRange ( $ipRange) |
| | Validate an IP range (valid address with a valid CIDR 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.
|
| |
A collection of public static functions to play with IP address and IP ranges.
Definition at line 67 of file IP.php.
| 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 315 of file IP.php.
| 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 513 of file IP.php.
| 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 152 of file IP.php.
| 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 266 of file IP.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqli\mysqlConnect().
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 417 of file IP.php.
1.10.0