Matching::authenticate() - Code Metrics - Inspection of "Add auto BasicAuth credential detection based on U..." - php-http/message - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#38)

by Márk

created 2016-03-04 21:17 UTC

Matching::authenticate() A

↳ Parent: Matching

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes	3
Bugs	0	Features	2

Metric	Value
c	3
b	0
f	2
dl	0
loc	8
ccs	3
cts	3
cp	1
rs	9.4285
cc	2
eloc	4
nc	2
nop	1
crap	2

<?php


namespace Http\Message\Authentication;

use Http\Message\Authentication;
use Http\Message\RequestMatcher\CallbackRequestMatcher;
use Psr\Http\Message\RequestInterface;

@trigger_error('The '.__NAMESPACE__.'\Matching class is deprecated since version 1.2 and will be removed in 2.0. Use Http\Message\Authentication\RequestConditional instead.', E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

/**
 * Authenticate a PSR-7 Request if the request is matching.
 *
 * @author Márk Sági-Kazár <[email protected]>
 *
 * @deprecated since since version 1.2, and will be removed in 2.0. Use {@link RequestConditional} instead.
 */
final class Matching implements Authentication
{
    /**
     * @var Authentication
     */
    private $authentication;

    /**
     * @var CallbackRequestMatcher
     */
    private $matcher;

    /**
     * @param Authentication $authentication
     * @param callable|null  $matcher
     */
    public function __construct(Authentication $authentication, callable $matcher = null)
    {
        if (is_null($matcher)) {
            $matcher = function () {
                return true;
            };
        }

        $this->authentication = $authentication;
        $this->matcher = new CallbackRequestMatcher($matcher);
    }

    /**
     * {@inheritdoc}
     */
    public function authenticate(RequestInterface $request)
    {
        if ($this->matcher->matches($request)) {
            return $this->authentication->authenticate($request);
        }

        return $request;
    }

    /**
     * Creates a matching authentication for an URL.
     *
     * @param Authentication $authentication
     * @param string         $url
     *
     * @return self
     */
    public static function createUrlMatcher(Authentication $authentication, $url)
    {
        $matcher = function (RequestInterface $request) use ($url) {
            return preg_match($url, $request->getRequestTarget());
        };

        return new static($authentication, $matcher);

    }
}


1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2016-03-04 19:57 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 18 and the first side effect is on line 9. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3		namespace Http\Message\Authentication;
4
5		use Http\Message\Authentication;
6		use Http\Message\RequestMatcher\CallbackRequestMatcher;
7		use Psr\Http\Message\RequestInterface;
8
9		@trigger_error('The '.__NAMESPACE__.'\Matching class is deprecated since version 1.2 and will be removed in 2.0. Use Http\Message\Authentication\RequestConditional instead.', E_USER_DEPRECATED);
		0 ignored issues – show Security Best Practice introduced 2016-03-04 19:57 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
10
11		/**
12		* Authenticate a PSR-7 Request if the request is matching.
13		*
14		* @author Márk Sági-Kazár <[email protected]>
15		*
16		* @deprecated since since version 1.2, and will be removed in 2.0. Use {@link RequestConditional} instead.
17		*/
18		final class Matching implements Authentication
19		{
20		/**
21		* @var Authentication
22		*/
23		private $authentication;
24
25		/**
26		* @var CallbackRequestMatcher
27		*/
28		private $matcher;
29
30		/**
31		* @param Authentication $authentication
32	5	* @param callable\|null $matcher
33		*/
34	5	public function __construct(Authentication $authentication, callable $matcher = null)
35		{
36		if (is_null($matcher)) {
37		$matcher = function () {
38		return true;
39		};
40	5	}
41	5
42	5	$this->authentication = $authentication;
43		$this->matcher = new CallbackRequestMatcher($matcher);
44		}
45
46		/**
47	2	* {@inheritdoc}
48		*/
49	2	public function authenticate(RequestInterface $request)
50	1	{
51		if ($this->matcher->matches($request)) {
52		return $this->authentication->authenticate($request);
53	1	}
54
55		return $request;
56		}
57
58		/**
59		* Creates a matching authentication for an URL.
60		*
61		* @param Authentication $authentication
62		* @param string $url
63		*
64		* @return self
65		*/
66	1	public static function createUrlMatcher(Authentication $authentication, $url)
67		{
68	1	$matcher = function (RequestInterface $request) use ($url) {
69		return preg_match($url, $request->getRequestTarget());
70	1	};
71
72		return new static($authentication, $matcher);
		0 ignored issues – show Deprecated Code introduced 2016-03-04 19:57 UTC by Report Bug Copy Issue Report The class `Http\Message\Authentication\Matching` has been deprecated with message: since since version 1.2, and will be removed in 2.0. Use {@link RequestConditional} instead. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
73		}
74		}
75

php-http / message

Pull Request — master (#38)

Matching::authenticate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like