Open Journal Systems  3.3.0
Public Member Functions
Symfony\Component\HttpFoundation\RequestMatcher Class Reference
Inheritance diagram for Symfony\Component\HttpFoundation\RequestMatcher:
Symfony\Component\HttpFoundation\RequestMatcherInterface Symfony\Component\HttpFoundation\ExpressionRequestMatcher

Public Member Functions

 __construct ($path=null, $host=null, $methods=null, $ips=null, array $attributes=array(), $schemes=null)
 
 __construct (string $path=null, string $host=null, $methods=null, $ips=null, array $attributes=[], $schemes=null, int $port=null)
 
 matchAttribute ($key, $regexp)
 
 matchAttribute ($key, $regexp)
 
 matches (Request $request)
 
 matches (Request $request)
 
 matchHost ($regexp)
 
 matchHost ($regexp)
 
 matchIp ($ip)
 
 matchIp ($ip)
 
 matchIps ($ips)
 
 matchIps ($ips)
 
 matchMethod ($method)
 
 matchMethod ($method)
 
 matchPath ($regexp)
 
 matchPath ($regexp)
 
 matchPort (?int $port)
 
 matchScheme ($scheme)
 
 matchScheme ($scheme)
 

Detailed Description

RequestMatcher compares a pre-defined set of checks against a Request instance.

Author
Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 19 of file lib/vendor/symfony/http-foundation/RequestMatcher.php.

Constructor & Destructor Documentation

◆ __construct() [1/2]

Symfony\Component\HttpFoundation\RequestMatcher::__construct (   $path = null,
  $host = null,
  $methods = null,
  $ips = null,
array  $attributes = array(),
  $schemes = null 
)
Parameters
string | null$path
string | null$host
string | string[] | null$methods
string | string[] | null$ips
array$attributes
string | string[] | null$schemes

Definition at line 77 of file lib/vendor/symfony/http-foundation/RequestMatcher.php.

References Symfony\Component\HttpFoundation\RequestMatcher\matchAttribute(), Symfony\Component\HttpFoundation\RequestMatcher\matchHost(), Symfony\Component\HttpFoundation\RequestMatcher\matchIps(), Symfony\Component\HttpFoundation\RequestMatcher\matchMethod(), Symfony\Component\HttpFoundation\RequestMatcher\matchPath(), and Symfony\Component\HttpFoundation\RequestMatcher\matchScheme().

◆ __construct() [2/2]

Symfony\Component\HttpFoundation\RequestMatcher::__construct ( string  $path = null,
string  $host = null,
  $methods = null,
  $ips = null,
array  $attributes = [],
  $schemes = null,
int  $port = null 
)
Parameters
string | string[] | null$methods
string | string[] | null$ips
string | string[] | null$schemes

Definition at line 82 of file vendor/symfony/http-foundation/RequestMatcher.php.

References Symfony\Component\HttpFoundation\RequestMatcher\matchAttribute(), Symfony\Component\HttpFoundation\RequestMatcher\matchHost(), Symfony\Component\HttpFoundation\RequestMatcher\matchIps(), Symfony\Component\HttpFoundation\RequestMatcher\matchMethod(), Symfony\Component\HttpFoundation\RequestMatcher\matchPath(), Symfony\Component\HttpFoundation\RequestMatcher\matchPort(), and Symfony\Component\HttpFoundation\RequestMatcher\matchScheme().

Member Function Documentation

◆ matchAttribute() [1/2]

Symfony\Component\HttpFoundation\RequestMatcher::matchAttribute (   $key,
  $regexp 
)

Adds a check for request attribute.

Parameters
string$keyThe request attribute name
string$regexpA Regexp

Definition at line 156 of file lib/vendor/symfony/http-foundation/RequestMatcher.php.

Referenced by Symfony\Component\HttpFoundation\RequestMatcher\__construct().

◆ matchAttribute() [2/2]

Symfony\Component\HttpFoundation\RequestMatcher::matchAttribute (   $key,
  $regexp 
)

Adds a check for request attribute.

Parameters
string$keyThe request attribute name
string$regexpA Regexp

Definition at line 172 of file vendor/symfony/http-foundation/RequestMatcher.php.

◆ matches() [1/2]

Symfony\Component\HttpFoundation\RequestMatcher::matches ( Request  $request)

{Decides whether the rule(s) implemented by the strategy matches the supplied request.

Parameters
Request$requestThe request to check for a match
Returns
bool true if the request matches, false otherwise
}

Implements Symfony\Component\HttpFoundation\RequestMatcherInterface.

Reimplemented in Symfony\Component\HttpFoundation\ExpressionRequestMatcher, and Symfony\Component\HttpFoundation\ExpressionRequestMatcher.

Definition at line 164 of file lib/vendor/symfony/http-foundation/RequestMatcher.php.

References Symfony\Component\HttpFoundation\IpUtils\checkIp(), Symfony\Component\HttpFoundation\Request\get(), Symfony\Component\HttpFoundation\Request\getClientIp(), Symfony\Component\HttpFoundation\Request\getHost(), Symfony\Component\HttpFoundation\Request\getMethod(), Symfony\Component\HttpFoundation\Request\getPathInfo(), and Symfony\Component\HttpFoundation\Request\getScheme().

◆ matches() [2/2]

Symfony\Component\HttpFoundation\RequestMatcher::matches ( Request  $request)

{Decides whether the rule(s) implemented by the strategy matches the supplied request.

Parameters
Request$requestThe request to check for a match
Returns
bool true if the request matches, false otherwise
}

Implements Symfony\Component\HttpFoundation\RequestMatcherInterface.

Reimplemented in Symfony\Component\HttpFoundation\ExpressionRequestMatcher, and Symfony\Component\HttpFoundation\ExpressionRequestMatcher.

Definition at line 180 of file vendor/symfony/http-foundation/RequestMatcher.php.

References Symfony\Component\HttpFoundation\IpUtils\checkIp(), Symfony\Component\HttpFoundation\Request\get(), Symfony\Component\HttpFoundation\Request\getClientIp(), Symfony\Component\HttpFoundation\Request\getHost(), Symfony\Component\HttpFoundation\Request\getMethod(), Symfony\Component\HttpFoundation\Request\getPathInfo(), Symfony\Component\HttpFoundation\Request\getPort(), and Symfony\Component\HttpFoundation\Request\getScheme().

◆ matchHost() [1/2]

Symfony\Component\HttpFoundation\RequestMatcher::matchHost (   $regexp)

Adds a check for the URL host name.

Parameters
string | null$regexpA Regexp

Definition at line 105 of file lib/vendor/symfony/http-foundation/RequestMatcher.php.

Referenced by Symfony\Component\HttpFoundation\RequestMatcher\__construct().

◆ matchHost() [2/2]

Symfony\Component\HttpFoundation\RequestMatcher::matchHost (   $regexp)

Adds a check for the URL host name.

Parameters
string | null$regexpA Regexp

Definition at line 111 of file vendor/symfony/http-foundation/RequestMatcher.php.

◆ matchIp() [1/2]

Symfony\Component\HttpFoundation\RequestMatcher::matchIp (   $ip)

Adds a check for the client IP.

Parameters
string$ipA specific IP address or a range specified using IP/netmask like 192.168.1.0/24

Definition at line 125 of file lib/vendor/symfony/http-foundation/RequestMatcher.php.

References Symfony\Component\HttpFoundation\RequestMatcher\matchIps().

◆ matchIp() [2/2]

Symfony\Component\HttpFoundation\RequestMatcher::matchIp (   $ip)

Adds a check for the client IP.

Parameters
string$ipA specific IP address or a range specified using IP/netmask like 192.168.1.0/24

Definition at line 141 of file vendor/symfony/http-foundation/RequestMatcher.php.

References Symfony\Component\HttpFoundation\RequestMatcher\matchIps().

◆ matchIps() [1/2]

Symfony\Component\HttpFoundation\RequestMatcher::matchIps (   $ips)

Adds a check for the client IP.

Parameters
string | string[] | null$ipsA specific IP address or a range specified using IP/netmask like 192.168.1.0/24

Definition at line 135 of file lib/vendor/symfony/http-foundation/RequestMatcher.php.

Referenced by Symfony\Component\HttpFoundation\RequestMatcher\__construct(), and Symfony\Component\HttpFoundation\RequestMatcher\matchIp().

◆ matchIps() [2/2]

Symfony\Component\HttpFoundation\RequestMatcher::matchIps (   $ips)

Adds a check for the client IP.

Parameters
string | string[] | null$ipsA specific IP address or a range specified using IP/netmask like 192.168.1.0/24

Definition at line 151 of file vendor/symfony/http-foundation/RequestMatcher.php.

◆ matchMethod() [1/2]

Symfony\Component\HttpFoundation\RequestMatcher::matchMethod (   $method)

Adds a check for the HTTP method.

Parameters
string | string[] | null$methodAn HTTP method or an array of HTTP methods

Definition at line 145 of file lib/vendor/symfony/http-foundation/RequestMatcher.php.

Referenced by Symfony\Component\HttpFoundation\RequestMatcher\__construct().

◆ matchMethod() [2/2]

Symfony\Component\HttpFoundation\RequestMatcher::matchMethod (   $method)

Adds a check for the HTTP method.

Parameters
string | string[] | null$methodAn HTTP method or an array of HTTP methods

Definition at line 161 of file vendor/symfony/http-foundation/RequestMatcher.php.

◆ matchPath() [1/2]

Symfony\Component\HttpFoundation\RequestMatcher::matchPath (   $regexp)

Adds a check for the URL path info.

Parameters
string | null$regexpA Regexp

Definition at line 115 of file lib/vendor/symfony/http-foundation/RequestMatcher.php.

Referenced by Symfony\Component\HttpFoundation\RequestMatcher\__construct().

◆ matchPath() [2/2]

Symfony\Component\HttpFoundation\RequestMatcher::matchPath (   $regexp)

Adds a check for the URL path info.

Parameters
string | null$regexpA Regexp

Definition at line 131 of file vendor/symfony/http-foundation/RequestMatcher.php.

◆ matchPort()

Symfony\Component\HttpFoundation\RequestMatcher::matchPort ( ?int  $port)

Adds a check for the the URL port.

Parameters
int | null$portThe port number to connect to

Definition at line 121 of file vendor/symfony/http-foundation/RequestMatcher.php.

Referenced by Symfony\Component\HttpFoundation\RequestMatcher\__construct().

◆ matchScheme() [1/2]

Symfony\Component\HttpFoundation\RequestMatcher::matchScheme (   $scheme)

Adds a check for the HTTP scheme.

Parameters
string | string[] | null$schemeAn HTTP scheme or an array of HTTP schemes

Definition at line 95 of file lib/vendor/symfony/http-foundation/RequestMatcher.php.

Referenced by Symfony\Component\HttpFoundation\RequestMatcher\__construct().

◆ matchScheme() [2/2]

Symfony\Component\HttpFoundation\RequestMatcher::matchScheme (   $scheme)

Adds a check for the HTTP scheme.

Parameters
string | string[] | null$schemeAn HTTP scheme or an array of HTTP schemes

Definition at line 101 of file vendor/symfony/http-foundation/RequestMatcher.php.

The documentation for this class was generated from the following file: