Référence de la classe IpHelper

Fonctions membres publiques statiques
static	getIp ()
static	setIp ($ip)
static	isIPv6 ($ip)
static	IPinList ($ip, $ipTable='')
static	workaroundIPIssues ()
static	setAllowIpOverrides ($newState)

Fonctions membres protégées statiques
static	detectAndCleanIP ()
static	detectIP ()
static	inetToBits ($inet)
static	checkIPv6CIDR ($ip, $cidrnet)

Fonctions membres privées
	__construct ()

Attributs privés statiques
static	$ip = null
static	$allowIpOverrides = false

Description détaillée

IpHelper is a utility class for processing IP addresses

Depuis

1.6.0

Documentation des constructeurs et destructeur

__construct()

__construct ( )

private

Private constructor to prevent instantiation of this class

Depuis

1.6.0

Documentation des fonctions membres

checkIPv6CIDR()

static checkIPv6CIDR (   $ip,   $cidrnet  )

staticprotected

Checks if an IPv6 address $ip is part of the IPv6 CIDR block $cidrnet

Paramètres

string	$ip	The IPv6 address to check, e.g. 21DA:00D3:0000:2F3B:02AC:00FF:FE28:9C5A
string	$cidrnet	The IPv6 CIDR block, e.g. 21DA:00D3:0000:2F3B::/64

Renvoie

boolean

Depuis

1.6.0

Références IpHelper\$ip.

detectAndCleanIP()

static detectAndCleanIP ( )

staticprotected

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
• https://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.

Renvoie

string

Depuis

1.6.0

Références IpHelper\$ip.

detectIP()

static detectIP ( )

staticprotected

Gets the visitor's IP address

Renvoie

string

Depuis

1.6.0

getIp()

static getIp ( )

static

Get the current visitor's IP address

Renvoie

string

Depuis

1.6.0

Références IpHelper\$ip, et null.

Référencé par ActionlogModel\addLog(), ArticleModel\storeVote(), et AddressValidator\validate().

inetToBits()

static inetToBits (   $inet )

staticprotected

Converts inet_pton output to bits string

Paramètres

string

$inet

The in_addr representation of an IPv4 or IPv6 address

Renvoie

string

Depuis

1.6.0

IPinList()

static IPinList (   $ip,   $ipTable = ''  )

static

Checks if an IP is contained in a list of IPs or IP expressions

Paramètres

string	$ip	The IPv4/IPv6 address to check
array | string	$ipTable	An IP expression (or a comma-separated or array list of IP expressions) to check against

Renvoie

boolean

Depuis

1.6.0

Références $base, $i, IpHelper\$ip, $val, et elseif.

isIPv6()

static isIPv6 (   $ip )

static

Is it an IPv6 IP address?

Paramètres

string

$ip

An IPv4 or IPv6 address

Renvoie

boolean

Depuis

1.6.0

Références IpHelper\$ip.

setAllowIpOverrides()

static setAllowIpOverrides (   $newState )

static

Should I allow the remote client's IP to be overridden by an X-Forwarded-For or Client-Ip HTTP header?

Paramètres

boolean

$newState

True to allow the override

Renvoie

void

Depuis

1.6.0

Références true.

setIp()

static setIp (   $ip )

static

Set the IP address of the current visitor

Paramètres

string

$ip

The visitor's IP address

Renvoie

void

Depuis

1.6.0

Références IpHelper\$ip.

workaroundIPIssues()

static workaroundIPIssues ( )

static

Works around the REMOTE_ADDR not containing the user's IP

Renvoie

void

Depuis

1.6.0

Références IpHelper\$ip, et elseif.

Documentation des champs

$allowIpOverrides

$allowIpOverrides = false

staticprivate

$ip

$ip = null

staticprivate

Référencé par IpHelper\checkIPv6CIDR(), IpHelper\detectAndCleanIP(), IpHelper\getIp(), IpHelper\IPinList(), IpHelper\isIPv6(), IpHelper\setIp(), et IpHelper\workaroundIPIssues().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• IpHelper.php