Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x

IpsRequestMatcher.php

Namespace

Symfony\Component\HttpFoundation\RequestMatcher

File

vendor/symfony/http-foundation/RequestMatcher/IpsRequestMatcher.php

View source
<?php


/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\HttpFoundation\RequestMatcher;

use Symfony\Component\HttpFoundation\IpUtils;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestMatcherInterface;

/**
 * Checks the client IP of a Request.
 *
 * @author Fabien Potencier <fabien@symfony.com>
 */
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);
    }

}

Classes

Title Deprecated Summary
IpsRequestMatcher Checks the client IP of a Request.

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal