Classes List

Symfony\Component\HttpFoundation\RequestMatcher

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
<?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 compares a pre-defined set of checks against a Request instance. * * @author Fabien Potencier <fabien@symfony.com> */
class RequestMatcher implements RequestMatcherInterface
{
    /** * @var string|null */
    private $path;

    /** * @var string|null */
    private $host;

    /** * @var string[] */
    private $methods = array();

    /** * @var string[] */
    private $ips = array();

    /** * @var array */
    private $attributes = array();

    /** * @var string[] */
    private $schemes = array();

    /** * @param string|null $path * @param string|null $host * @param string|string[]|null $methods * @param string|string[]|null $ips * @param array $attributes * @param string|string[]|null $schemes */
    public function __construct($path = null$host = null$methods = null$ips = nullarray $attributes = array(), $schemes = null)
    {
        $this->matchPath($path);
        $this->matchHost($host);
        $this->matchMethod($methods);
        $this->matchIps($ips);
        $this->matchScheme($schemes);

        foreach ($attributes as $k => $v) {
            $this->matchAttribute($k$v);
        }
    }

    /** * Adds a check for the HTTP scheme. * * @param string|string[]|null $scheme An HTTP scheme or an array of HTTP schemes */
    public function matchScheme($scheme)
    {
        $this->schemes = null !== $scheme ? array_map('strtolower'(array) $scheme) : array();
    }

    /** * Adds a check for the URL host name. * * @param string|null $regexp A Regexp */
    public function matchHost($regexp)
    {
        $this->host = $regexp;
    }

    /** * Adds a check for the URL path info. * * @param string|null $regexp A Regexp */
    public function matchPath($regexp)
    {
        $this->path = $regexp;
    }

    /** * Adds a check for the client IP. * * @param string $ip A specific IP address or a range specified using IP/netmask like 192.168.1.0/24 */
    public function matchIp($ip)
    {
        $this->matchIps($ip);
    }

    /** * Adds a check for the client IP. * * @param string|string[]|null $ips A specific IP address or a range specified using IP/netmask like 192.168.1.0/24 */
    public function matchIps($ips)
    {
        $this->ips = null !== $ips ? (array) $ips : array();
    }

    /** * Adds a check for the HTTP method. * * @param string|string[]|null $method An HTTP method or an array of HTTP methods */
    public function matchMethod($method)
    {
        $this->methods = null !== $method ? array_map('strtoupper'(array) $method) : array();
    }

    /** * Adds a check for request attribute. * * @param string $key The request attribute name * @param string $regexp A Regexp */
    public function matchAttribute($key$regexp)
    {
        $this->attributes[$key] = $regexp;
    }

    /** * {@inheritdoc} */
    public function matches(Request $request)
    {
        if ($this->schemes && !in_array($request->getScheme(), $this->schemestrue)) {
            return false;
        }

        if ($this->methods && !in_array($request->getMethod(), $this->methodstrue)) {
            return false;
        }

        foreach ($this->attributes as $key => $pattern) {
            if (!preg_match('{'.$pattern.'}'$request->attributes->get($key))) {
                return false;
            }
        }

        if (null !== $this->path && !preg_match('{'.$this->path.'}'rawurldecode($request->getPathInfo()))) {
            return false;
        }

        if (null !== $this->host && !preg_match('{'.$this->host.'}i'$request->getHost())) {
            return false;
        }

        if (IpUtils::checkIp($request->getClientIp(), $this->ips)) {
            return true;
        }

        // Note to future implementors: add additional checks above the
        // foreach above or else your check might not be run!
        return 0 === count($this->ips);
    }
}