Completed
Push — master ( 46448f...1fae80 )
by Derek
03:09
created

Query   A

Complexity

Total Complexity 7

Size/Duplication

Total Lines 91
Duplicated Lines 100 %

Coupling/Cohesion

Components 3
Dependencies 1

Test Coverage

Coverage 100%

Importance

Changes 3
Bugs 0 Features 0
Metric Value
wmc 7
lcom 3
cbo 1
dl 91
loc 91
ccs 33
cts 33
cp 1
rs 10
c 3
b 0
f 0

4 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 13 13 3
A toUriString() 10 10 2
A compileValidPattern() 10 10 1
A compileUnencodedCharacters() 9 9 1

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
namespace Subreality\Dilmun\Anshar\Http\UriParts;
3
4
/**
5
 * Class Query
6
 * @package Subreality\Dilmun\Anshar\Http\UriParts
7
 */
8 View Code Duplication
class Query extends AbstractUriPart
1 ignored issue
show
Duplication introduced by
This class seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
9
{
10
    protected $unencoded_characters = array("/", "?");
11
12
    /**
13
     * Query constructor. Accepts a string representing a URI query. Construction will throw an exception if the
14
     * query is not a string.
15
     *
16
     * Construction accepts strings that have been percent-encoded as well as strings that have not been percent-encoded
17
     * and will encode invalid characters.
18
     *
19
     * Construction with a string that includes both encoded and decoded characters will be assumed to be an encoded
20
     * string, resulting in double-encoding.
21
     *
22
     * query       = *( pchar / "/" / "?" )
23
     * pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"
24
     * unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
25
     * pct-encoded = "%" HEXDIG HEXDIG
26
     * sub-delims  = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
27
     *
28
     * @see https://tools.ietf.org/html/rfc3986#appendix-A
29
     *
30
     * @throws \InvalidArgumentException
31
     *
32
     * @param string $query     A string representing a URI query
33
     */
34 89
    public function __construct($query)
35
    {
36 89
        $this->compileValidPattern();
37 89
        $this->compileUnencodedCharacters();
38
39 89
        if (!is_string($query)) {
40 6
            throw new \InvalidArgumentException("Query must be a string");
41 83
        } elseif (!self::isValid($query)) {
42 7
            $query = $this->encode($query);
43 7
        }
44
45 83
        $this->data = $query;
46 83
    }
47
48
    /**
49
     * Returns a string representation of the query formatted so that it can be compiled into a complete URI string
50
     * per the Uri object's string specification.
51
     *
52
     * If the query is empty, toUriString returns an empty string; if the query is not empty, toUriString returns the
53
     * query prefixed with a question mark.
54
     *
55
     * @see Uri::__toString
56
     *
57
     * @return string   A string representation of the query formatted for a complete URI string
58
     */
59 33
    public function toUriString()
60
    {
61 33
        $uri_query = $this->data;
62
63 33
        if (!empty($uri_query)) {
64 27
            $uri_query = "?" . $uri_query;
65 27
        }
66
67 33
        return $uri_query;
68
    }
69
70
    /**
71
     * Compiles a regexp pattern based on predefined patterns that define allowed characters for a query.
72
     */
73 89
    protected function compileValidPattern()
74
    {
75 89
        self::$valid_pattern = '/^([\/\?' .
76 89
            $this->unreserved_pattern .
77 89
            $this->sub_delims_pattern .
78 89
            $this->pchar_pattern .
79 89
            ']|' .                          //predefined patterns or percent-encoding
80 89
            $this->pct_encoded_pattern .
81 89
            ')*$/';
82 89
    }
83
84
    /**
85
     * Compiles an array of legal characters for a query based upon the RFC3986 specification:
86
     *
87
     * query = *( pchar / "/" / "?" )
88
     */
89 89
    protected function compileUnencodedCharacters()
90
    {
91 89
        $this->unencoded_characters = array_merge(
92 89
            $this->unencoded_characters,
93 89
            $this->unreserved_characters,
94 89
            $this->pchar_characters,
95 89
            $this->sub_delims_characters
96 89
        );
97 89
    }
98
}
99