Url::setUrl() - Code Metrics - Inspection of "Add Drupal 8 support" - BR0kEN-/TqExtension - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#16)

by Sergii

created 2017-01-04 21:40 UTC

Url::setUrl() A

↳ Parent: Url

Complexity

Conditions	3
Paths	2

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
dl	0
loc	11
rs	9.4285
cc	3
eloc	6
nc	2
nop	1

<?php
/**
 * @author Sergii Bondarenko, <[email protected]>
 */
namespace Drupal\TqExtension\Utils;

/**
 * Class Url.
 *
 * @package Drupal\TqExtension\Utils
 */
class Url
{
    /**
     * URL to build.
     *
     * @var string
     */
    private $url = '';
    /**
     * URL components.
     *
     * @var string[]
     */
    private $components = [];

    /**
     * Url constructor.
     *
     * @param string $baseUrl
     *   Base URL.
     * @param string $path
     *   Path on a base URL.
     */
    public function __construct($baseUrl, $path = '')
    {
        if (empty($baseUrl)) {
            throw new \InvalidArgumentException('Set base URL before continue.');
        }

        // Start with base URL when path is empty, or not starts from "//" or "http".
        if (empty($path) || strpos($path, '//') !== 0 && strpos($path, 'http') !== 0) {
            $path = rtrim($baseUrl, '/') . '/' . trim($path, '/');
        }

        $this->setUrl($path)->scheme()->credentials()->host()->components();
    }

    /**
     * @return string
     *   Constructed URL.
     */
    public function __toString()
    {
        return $this->url;
    }

    /**
     * Initialize URL creation.
     *
     * @param string $url
     *
     * @return $this
     */
    private function setUrl($url)
    {
        $this->url = $url;
        $this->components = parse_url(strtolower($this->url));
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        if (false === $this->components || !isset($this->components['host'])) {
            throw new \InvalidArgumentException(sprintf('%s - incorrect URL.', $this->url));
        }

        return $this;
    }

    /**
     * Append HTTP scheme.
     *
     * @return $this
     */
    private function scheme()
    {
        $this->components += [
            // When URL starts from "//" the "scheme" key will not exists.
            'scheme' => 'http',
        ];

        // Check scheme.
        if (!in_array($this->components['scheme'], ['http', 'https'])) {
            throw new \InvalidArgumentException(sprintf('%s - invalid scheme.', $this->components['scheme']));
        }

        $this->url = $this->components['scheme'] . '://';

        return $this;
    }

    /**
     * Append authentication credentials.
     *
     * @return $this
     */
    private function credentials()
    {
        if (isset($this->components['user'], $this->components['pass'])) {
            // Encode special characters in username and password. Useful
            // when some item contain something like "@" symbol.
            foreach (['user' => ':', 'pass' => '@'] as $part => $suffix) {
                $this->url .= rawurlencode($this->components[$part]) . $suffix;
            }
        }

        return $this;
    }

    /**
     * Append host.
     *
     * @return $this
     */
    private function host()
    {
        $this->url .= $this->components['host'];

        return $this;
    }

    /**
     * Append additional URL components.
     *
     * @return $this
     */
    private function components()
    {
        foreach (['port' => ':', 'path' => '', 'query' => '?', 'fragment' => '#'] as $part => $prefix) {
            if (isset($this->components[$part])) {
                $this->url .= $prefix . $this->components[$part];
            }
        }

        return $this;
    }
}


1			<?php
2			/**
3			* @author Sergii Bondarenko, <[email protected]>
4			*/
5			namespace Drupal\TqExtension\Utils;
6
7			/**
8			* Class Url.
9			*
10			* @package Drupal\TqExtension\Utils
11			*/
12			class Url
13			{
14			/**
15			* URL to build.
16			*
17			* @var string
18			*/
19			private $url = '';
20			/**
21			* URL components.
22			*
23			* @var string[]
24			*/
25			private $components = [];
26
27			/**
28			* Url constructor.
29			*
30			* @param string $baseUrl
31			* Base URL.
32			* @param string $path
33			* Path on a base URL.
34			*/
35			public function __construct($baseUrl, $path = '')
36			{
37			if (empty($baseUrl)) {
38			throw new \InvalidArgumentException('Set base URL before continue.');
39			}
40
41			// Start with base URL when path is empty, or not starts from "//" or "http".
42			if (empty($path) \|\| strpos($path, '//') !== 0 && strpos($path, 'http') !== 0) {
43			$path = rtrim($baseUrl, '/') . '/' . trim($path, '/');
44			}
45
46			$this->setUrl($path)->scheme()->credentials()->host()->components();
47			}
48
49			/**
50			* @return string
51			* Constructed URL.
52			*/
53			public function __toString()
54			{
55			return $this->url;
56			}
57
58			/**
59			* Initialize URL creation.
60			*
61			* @param string $url
62			*
63			* @return $this
64			*/
65			private function setUrl($url)
66			{
67			$this->url = $url;
68			$this->components = parse_url(strtolower($this->url));
			1 ignored issue – show Documentation Bug introduced 2017-01-02 15:14 UTC by Report Bug Copy Issue Report It seems like `parse_url(strtolower($this->url))` can also be of type `false`. However, the property `$components` is declared as type `array<integer,string>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
69
70			if (false === $this->components \|\| !isset($this->components['host'])) {
71			throw new \InvalidArgumentException(sprintf('%s - incorrect URL.', $this->url));
72			}
73
74			return $this;
75			}
76
77			/**
78			* Append HTTP scheme.
79			*
80			* @return $this
81			*/
82			private function scheme()
83			{
84			$this->components += [
85			// When URL starts from "//" the "scheme" key will not exists.
86			'scheme' => 'http',
87			];
88
89			// Check scheme.
90			if (!in_array($this->components['scheme'], ['http', 'https'])) {
91			throw new \InvalidArgumentException(sprintf('%s - invalid scheme.', $this->components['scheme']));
92			}
93
94			$this->url = $this->components['scheme'] . '://';
95
96			return $this;
97			}
98
99			/**
100			* Append authentication credentials.
101			*
102			* @return $this
103			*/
104			private function credentials()
105			{
106			if (isset($this->components['user'], $this->components['pass'])) {
107			// Encode special characters in username and password. Useful
108			// when some item contain something like "@" symbol.
109			foreach (['user' => ':', 'pass' => '@'] as $part => $suffix) {
110			$this->url .= rawurlencode($this->components[$part]) . $suffix;
111			}
112			}
113
114			return $this;
115			}
116
117			/**
118			* Append host.
119			*
120			* @return $this
121			*/
122			private function host()
123			{
124			$this->url .= $this->components['host'];
125
126			return $this;
127			}
128
129			/**
130			* Append additional URL components.
131			*
132			* @return $this
133			*/
134			private function components()
135			{
136			foreach (['port' => ':', 'path' => '', 'query' => '?', 'fragment' => '#'] as $part => $prefix) {
137			if (isset($this->components[$part])) {
138			$this->url .= $prefix . $this->components[$part];
139			}
140			}
141
142			return $this;
143			}
144			}
145

BR0kEN- / TqExtension

Pull Request — master (#16)

Url::setUrl() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like