IP Address

The IPAddress class is a helper class designed to retrieve user IP address or IP address information using third-party IP information APIs to obtain more details about the user's IP address. Once the IP address information is received, the class stores it for subsequent requests, reducing the number of requests to the third-party API.

Helper Functions

Global helper function to get user ip address.

<?php
echo ip_address();

To get user ip address information.

<?php
$info = ip_address(true);
var_export($info);

Global helper function to get ip address instance.

<?php
$instance = func('ip');

• Class namespace: \Luminova\Functions\IPAddress

Methods

get

Get the client's IP address.

public static get(): string

Return Value:

string - The client's IP address or '0.0.0.0' if not found.

info

Get IP address information from third party API and store it for later use.

public static info(string|null $ip = null, array $options = []): null|object

Parameters:

Return Value:

null|object - Return ip address information or null if not found.

isTrustedProxy

Check if the request origin IP matches any of the trusted proxy IP addresses or subnets.

public static isTrustedProxy(?string $ip = null): bool

Parameters:

Return Value:

bool - Return true if the request origin IP matches the trusted proxy IPs, false otherwise.

isValid

Check if an IP address is valid ip-version (e.g: ipv4 or ipv6).

public static isValid(?string $address = null, int $version): bool

Parameters:

Return Value:

bool - True if the IP address is valid, false otherwise.

toNumeric

Convert an IP address to its numeric representation (IPv4 or IPv6).

public static toNumeric(?string $address = null): int|string

Parameters:

Return Value:

int|string - Numeric IP address or empty string on error.

toAddress

Convert a numeric IP address to its string representation (IPv4 or IPv6).

public static toAddress(int|string $numeric = null): string

Parameters:

Return Value:

string - IP address in string format or empty string on error.

isTor

Checks if the given IP address is a Tor exit node

public static isTor(string|null $ip = null): bool

Parameters:

Return Value:

bool - Return true if the IP address is a Tor exit node.

Global helper function to check if IP address is tor is_tor()