PHP Class Vectorface\Whip\IpRange\IpWhitelist

Author: Daniel Bruce ([email protected])

Show file Open project: vectorface/whip Class Usage Examples

Public Methods

Method	Description
__construct ( array $whitelists )	Constructor for the class.
isIpWhitelisted ( string $ipAddress ) : boolean	Returns whether or not the given IP address is within the whitelist.

Private Methods

Method	Description
constructWhiteListForKey ( array $whitelist, string $key, string $class ) : array	Constructs the whitelist for the given key. Each element in the whitelist gets mapped from a string to an instance of an Ipv4Range or Ipv6Range.
isIpInWhitelist ( array $whitelist, string $ipAddress ) : boolean	Returns whether or not the given IP address is in the given whitelist.

Method Details

__construct() public method

Constructor for the class.

public __construct ( array $whitelists )
$whitelists	array	An array with two keys ('ipv4' and 'ipv6') with each key mapping to an array of valid IP ranges.

isIpWhitelisted() public method

Returns whether or not the given IP address is within the whitelist.

public isIpWhitelisted ( string $ipAddress ) : boolean
$ipAddress	string	A valid IPv4 or IPv6 address.
return	boolean	Returns true if the IP address matches one of the whitelisted IP ranges and false otherwise.