class IpsRequestMatcher

Checks the client IP of a Request.

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

Expanded class hierarchy of IpsRequestMatcher

File

vendor/symfony/http-foundation/RequestMatcher/IpsRequestMatcher.php, line 23

Namespace

Symfony\Component\HttpFoundation\RequestMatcher
View source 
class IpsRequestMatcher implements RequestMatcherInterface {
    private array $ips;
    
    /**
     * @param string[]|string $ips A specific IP address or a range specified using IP/netmask like 192.168.1.0/24
     *                             Strings can contain a comma-delimited list of IPs/ranges
     */
    public function __construct(array|string $ips) {
        $this->ips = array_reduce((array) $ips, static fn(array $ips, string $ip) => array_merge($ips, preg_split('/\\s*,\\s*/', $ip)), []);
    }
    public function matches(Request $request) : bool {
        if (!$this->ips) {
            return true;
        }
        return IpUtils::checkIp($request->getClientIp() ?? '', $this->ips);
    }

}

Members

Title Modifiers Object type Summary Overriden Title
IpsRequestMatcher::$ips private property
IpsRequestMatcher::matches public function Decides whether the rule(s) implemented by the strategy matches the supplied request. Overrides RequestMatcherInterface::matches
IpsRequestMatcher::__construct public function