AbstractNegotiator::match() - Code Metrics - Inspection of "Fix potential E_WARNING because of array_map()" - willdurand/Negotiation - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#82)

by William

created 2016-08-23 10:26 UTC

AbstractNegotiator::match() A

↳ Parent: AbstractNegotiator

Complexity

Conditions	3
Paths	2

Size

Total Lines	15
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3

Importance

Changes

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

<?php

namespace Negotiation;

use Negotiation\Exception\InvalidArgument;
use Negotiation\Exception\InvalidHeader;

abstract class AbstractNegotiator
{
    /**
     * @param string $header     A string containing an `Accept|Accept-*` header.
     * @param array  $priorities A set of server priorities.
     *
     * @return AcceptHeader|null best matching type
     */
    public function getBest($header, array $priorities)
    {
        if (empty($priorities)) {
            throw new InvalidArgument('A set of server priorities should be given.');
        }

        if (!$header) {
            throw new InvalidArgument('The header string should not be empty.');
        }

        $headers = $this->parseHeader($header);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        // Once upon a time, two `array_map` calls were sitting there, but for
        // some reasons, they triggered `E_WARNING` time to time (because of
        // PHP bug [55416](https://bugs.php.net/bug.php?id=55416). Now, they
        // are gone.
        // See: https://github.com/willdurand/Negotiation/issues/81

        $acceptedHeaders = array();
        foreach ($this->parseHeader($header) as $h) {
            $acceptedHeaders[] = $this->acceptFactory($h);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        $acceptedPriorities = array();
        foreach ($priorities as $p) {
            $acceptedPriorities[] = $this->acceptFactory($p);
        }

        $matches         = $this->findMatches($acceptedHeaders, $acceptedPriorities);
        $specificMatches = array_reduce($matches, 'Negotiation\Match::reduce', []);

        usort($specificMatches, 'Negotiation\Match::compare');

        $match = array_shift($specificMatches);

        return null === $match ? null : $acceptedPriorities[$match->index];
    }

    /**
     * @param string $header accept header part or server priority
     *
     * @return AcceptHeader Parsed header object
     */
    abstract protected function acceptFactory($header);

    /**
     * @param AcceptHeader $header
     * @param AcceptHeader $priority
     * @param integer      $index
     *
     * @return Match|null Headers matched
     */
    protected function match(AcceptHeader $header, AcceptHeader $priority, $index)
    {
        $ac = $header->getType();
        $pc = $priority->getType();

        $equal = !strcasecmp($ac, $pc);

        if ($equal || $ac === '*') {
            $score = 1 * $equal;

            return new Match($header->getQuality(), $score, $index);
        }

        return null;
    }

    /**
     * @param string $header A string that contains an `Accept*` header.
     *
     * @return AcceptHeader[]
     */
    private function parseHeader($header)
    {
        $res = preg_match_all('/(?:[^,"]*+(?:"[^"]*+")?)+[^,"]*+/', $header, $matches);

        if (!$res) {
            throw new InvalidHeader(sprintf('Failed to parse accept header: "%s"', $header));
        }

        return array_values(array_filter(array_map('trim', $matches[0])));
    }

    /**
     * @param AcceptHeader[] $headerParts
     * @param Priority[]     $priorities  Configured priorities
     *
     * @return Match[] Headers matched
     */
    private function findMatches(array $headerParts, array $priorities)
    {
        $matches = [];
        foreach ($priorities as $index => $p) {
            foreach ($headerParts as $h) {
                if (null !== $match = $this->match($h, $p, $index)) {
                    $matches[] = $match;
                }
            }
        }

        return $matches;
    }
}


1		<?php
2
3		namespace Negotiation;
4
5		use Negotiation\Exception\InvalidArgument;
6		use Negotiation\Exception\InvalidHeader;
7
8		abstract class AbstractNegotiator
9		{
10		/**
11		* @param string $header A string containing an `Accept\|Accept-*` header.
12		* @param array $priorities A set of server priorities.
13		*
14		* @return AcceptHeader\|null best matching type
15		*/
16	58	public function getBest($header, array $priorities)
17		{
18	58	if (empty($priorities)) {
19	1	throw new InvalidArgument('A set of server priorities should be given.');
20		}
21
22	57	if (!$header) {
23	3	throw new InvalidArgument('The header string should not be empty.');
24		}
25
26	54	$headers = $this->parseHeader($header);
		0 ignored issues – show Unused Code introduced 2016-08-23 10:32 UTC by Report Bug Copy Issue Report `$headers` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
27
28		// Once upon a time, two `array_map` calls were sitting there, but for
29		// some reasons, they triggered `E_WARNING` time to time (because of
30		// PHP bug [55416](https://bugs.php.net/bug.php?id=55416). Now, they
31		// are gone.
32		// See: https://github.com/willdurand/Negotiation/issues/81
33
34	54	$acceptedHeaders = array();
35	54	foreach ($this->parseHeader($header) as $h) {
36	54	$acceptedHeaders[] = $this->acceptFactory($h);
		0 ignored issues – show Documentation introduced 2016-08-23 10:32 UTC by Report Bug Copy Issue Report `$h` is of type `object<Negotiation\AcceptHeader>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
37	53	}
38
39	53	$acceptedPriorities = array();
40	53	foreach ($priorities as $p) {
41	53	$acceptedPriorities[] = $this->acceptFactory($p);
42	52	}
43
44	52	$matches = $this->findMatches($acceptedHeaders, $acceptedPriorities);
45	52	$specificMatches = array_reduce($matches, 'Negotiation\Match::reduce', []);
46
47	52	usort($specificMatches, 'Negotiation\Match::compare');
48
49	52	$match = array_shift($specificMatches);
50
51	52	return null === $match ? null : $acceptedPriorities[$match->index];
52		}
53
54		/**
55		* @param string $header accept header part or server priority
56		*
57		* @return AcceptHeader Parsed header object
58		*/
59		abstract protected function acceptFactory($header);
60
61		/**
62		* @param AcceptHeader $header
63		* @param AcceptHeader $priority
64		* @param integer $index
65		*
66		* @return Match\|null Headers matched
67		*/
68	17	protected function match(AcceptHeader $header, AcceptHeader $priority, $index)
69		{
70	17	$ac = $header->getType();
71	17	$pc = $priority->getType();
72
73	17	$equal = !strcasecmp($ac, $pc);
74
75	17	if ($equal \|\| $ac === '*') {
76	14	$score = 1 * $equal;
77
78	14	return new Match($header->getQuality(), $score, $index);
79		}
80
81	17	return null;
82		}
83
84		/**
85		* @param string $header A string that contains an `Accept*` header.
86		*
87		* @return AcceptHeader[]
88		*/
89	71	private function parseHeader($header)
90		{
91	71	$res = preg_match_all('/(?:[^,"]+(?:"[^"]+")?)+[^,"]*+/', $header, $matches);
92
93	71	if (!$res) {
94		throw new InvalidHeader(sprintf('Failed to parse accept header: "%s"', $header));
95		}
96
97	71	return array_values(array_filter(array_map('trim', $matches[0])));
98		}
99
100		/**
101		* @param AcceptHeader[] $headerParts
102		* @param Priority[] $priorities Configured priorities
103		*
104		* @return Match[] Headers matched
105		*/
106	55	private function findMatches(array $headerParts, array $priorities)
107		{
108	55	$matches = [];
109	55	foreach ($priorities as $index => $p) {
110	55	foreach ($headerParts as $h) {
111	55	if (null !== $match = $this->match($h, $p, $index)) {
112	46	$matches[] = $match;
113	46	}
114	55	}
115	55	}
116
117	55	return $matches;
118		}
119		}
120

willdurand / Negotiation

GitHub Access Token became invalid

Pull Request — master (#82)

AbstractNegotiator::match() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like