Class FOFUtilsIp

IP address utilities

Abstract
Package: FrameworkOnFramework\utils
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Located at fof/utils/ip/ip.php

Methods summary

`public static string`	# `getIp( )` Get the current visitor's IP address Get the current visitor's IP address Returns `string`
`public static`	# `setIp( string $ip )` Set the IP address of the current visitor Set the IP address of the current visitor Parameters `$ip` `string` - $ip
`public static boolean`	# `isIPv6( string $ip )` Is it an IPv6 IP address? Is it an IPv6 IP address? Parameters `$ip` `string` - $ip An IPv4 or IPv6 address Returns `boolean` - True if it's IPv6
`public static null\|boolean`	# `IPinList( string $ip, array\|string $ipTable = '' )` Checks if an IP is contained in a list of IPs or IP expressions Checks if an IP is contained in a list of IPs or IP expressions Parameters `$ip` `string` - $ip The IPv4/IPv6 address to check `$ipTable` `array\|string` - $ipTable An IP expression (or a comma-separated or array list of IP expressions) to check against Returns `null\|boolean` - True if it's in the list
`public static`	# `workaroundIPIssues( )` Works around the REMOTE_ADDR not containing the user's IP Works around the REMOTE_ADDR not containing the user's IP
`public static`	# `setAllowIpOverrides( boolean $newState )` Should I allow the remote client's IP to be overridden by an X-Forwarded-For or Client-Ip HTTP header? Should I allow the remote client's IP to be overridden by an X-Forwarded-For or Client-Ip HTTP header? Parameters `$newState` `boolean` - $newState True to allow the override
`protected static string`	# `detectAndCleanIP( )` Gets the visitor's IP address. Automatically handles reverse proxies reporting the IPs of intermediate devices, like load balancers. Examples: https://www.akeebabackup.com/support/admin-tools/13743-double-ip-adresses-in-security-exception-log-warnings.html http://stackoverflow.com/questions/2422395/why-is-request-envremote-addr-returning-two-ips The solution used is assuming that the last IP address is the external one. Gets the visitor's IP address. Automatically handles reverse proxies reporting the IPs of intermediate devices, like load balancers. Examples: https://www.akeebabackup.com/support/admin-tools/13743-double-ip-adresses-in-security-exception-log-warnings.html http://stackoverflow.com/questions/2422395/why-is-request-envremote-addr-returning-two-ips The solution used is assuming that the last IP address is the external one. Returns `string`
`protected static string`	# `detectIP( )` Gets the visitor's IP address Gets the visitor's IP address Returns `string`
`protected static string`	# `inet_to_bits( string $inet )` Converts inet_pton output to bits string Converts inet_pton output to bits string Parameters `$inet` `string` - $inet The in_addr representation of an IPv4 or IPv6 address Returns `string`
`protected static boolean`	# `checkIPv6CIDR( string $ip, string $cidrnet )` Checks if an IPv6 address $ip is part of the IPv6 CIDR block $cidrnet Checks if an IPv6 address $ip is part of the IPv6 CIDR block $cidrnet Parameters `$ip` `string` - $ip The IPv6 address to check, e.g. 21DA:00D3:0000:2F3B:02AC:00FF:FE28:9C5A `$cidrnet` `string` - $cidrnet The IPv6 CIDR block, e.g. 21DA:00D3:0000:2F3B::/64 Returns `boolean`

Magic methods summary

Properties summary

`protected static string`	`$ip`	# The IP address of the current visitor The IP address of the current visitor
`protected static boolean`	`$allowIpOverrides`	# Should I allow IP overrides through X-Forwarded-For or Client-Ip HTTP headers? Should I allow IP overrides through X-Forwarded-For or Client-Ip HTTP headers?

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFUtilsIp

Methods summary

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Magic methods summary

Properties summary