UrlTemplate::templateBuild() - Code Metrics - shakhraj/ReRoute - Measure and Improve Code Quality continuously with Scrutinizer

UrlTemplate::templateBuild() A
last analyzed 2016-04-28 14:34 UTC

↳ Parent: UrlTemplate

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	10
ccs	6
cts	6
cp	1
rs	9.4285
cc	2
eloc	5
nc	2
nop	2
crap	2

<?php

  namespace ReRoute\Template;

  use ReRoute\ParameterStore;
  use ReRoute\RequestContext;
  use ReRoute\Url;
  use ReRoute\UrlBuilder;

  /**
   * @package ReRoute\Template
   */
  class UrlTemplate {

    use ParameterStore;

    CONST PARAMETER_SCHEME = 'scheme';

    CONST PARAMETER_HOST = 'host';

    CONST PARAMETER_PATH = 'path';

    CONST PARAMETER_METHOD = 'method';


    /**
     * @var Template
     */
    protected $pathTemplate = null;


    /**
     * @var Template
     */
    protected $hostTemplate = null;


    /**
     * @var string
     */
    protected $scheme = null;


    /**
     * @var string
     */
    protected $method = null;


    /**
     * UrlTemplate constructor.
     * @param array $parameters
     * @throws \InvalidArgumentException
     */
    public function __construct(array $parameters = []) {
      foreach ($parameters as $key => $value) {
        if ($key == self::PARAMETER_METHOD) {
          $this->setMethod($value);
          continue;
        }
        if ($key == self::PARAMETER_SCHEME) {
          $this->setScheme($value);
          continue;
        }
        if ($key == self::PARAMETER_HOST) {
          $this->setHostTemplate($value);
          continue;
        }
        if ($key == self::PARAMETER_PATH) {
          $this->setPathTemplate($value);
          continue;
        }

        throw new \InvalidArgumentException('Unsupported parameter: ' . $key);
      }
    }


    /**
     * @param RequestContext $requestContext
     * @return bool
     */
    public function isMatched(RequestContext $requestContext) {
      if (!empty($this->pathTemplate)) {
        if ($this->pathTemplate->match($requestContext->getPath(), $matchedParams)) {
          $this->storeDefaultParameters($matchedParams);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } else {
          return false;
        }
      }

      if (!empty($this->hostTemplate)) {
        if ($this->hostTemplate->match($requestContext->getHost(), $matchedParams)) {
          $this->storeParameters($matchedParams);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } else {
          return false;
        }
      }

      if (!empty($this->scheme)) {
        if (!in_array($requestContext->getScheme(), explode('|', $this->scheme))) {
          return false;
        }
      }

      if (!empty($this->method)) {
        if (!in_array(strtolower($requestContext->getMethod()), explode('|', $this->method))) {
          return false;
        }
      }

      return true;
    }


    /**
     * @param Url $url
     * @param UrlBuilder $urlBuilder
     */
    public function build(Url $url, UrlBuilder $urlBuilder) {
      if (!empty($this->hostTemplate)) {
        $url->setHost($this->templateBuild($this->hostTemplate, $urlBuilder));
      }

      if (!empty($this->pathTemplate)) {
        $url->setPath($this->templateBuild($this->pathTemplate, $urlBuilder));
      }

      if (!empty($this->scheme)) {
        $url->setScheme($this->scheme);
      }
    }


    /**
     * @param Template $template
     * @param UrlBuilder $urlBuilder
     * @return string
     */
    protected function templateBuild(Template $template, UrlBuilder $urlBuilder) {


      $path = $template->build($urlBuilder->getAllParameters(), $usedParameters);
      foreach ($usedParameters as $name) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
        $urlBuilder->useParameter($name);
      }

      return $path;
    }


    /**
     * @return Template
     */
    public function getPathTemplate() {
      return $this->pathTemplate;
    }


    /**
     * @param string $pathTemplate
     *
     * @return $this
     */
    public function setPathTemplate($pathTemplate) {
      if (is_string($pathTemplate)) {
        $this->pathTemplate = new Template($pathTemplate);
      } elseif ($pathTemplate instanceof Template) {
        $this->pathTemplate = $pathTemplate;
      } else {
        throw new \InvalidArgumentException("Invalid pathTemplate parameter. Expect string or instance of Template. Given:" . gettype($pathTemplate));
      }

      return $this;
    }


    /**
     * @return Template
     */
    public function getHostTemplate() {
      return $this->hostTemplate;
    }


    /**
     * @param string $hostTemplate
     *
     * @return $this
     */
    public function setHostTemplate($hostTemplate) {
      if (is_string($hostTemplate)) {
        $this->hostTemplate = new Template($hostTemplate);
      } elseif ($hostTemplate instanceof Template) {
        $this->hostTemplate = $hostTemplate;
      } else {
        throw new \InvalidArgumentException("Invalid hostTemplate parameter. Expect string or instance of Template. Given:" . gettype($hostTemplate));
      }

      return $this;
    }


    /**
     * @return string
     */
    public function getScheme() {
      return $this->scheme;
    }


    /**
     * @param string|\string[] $scheme
     *
     * @return $this
     */
    public function setScheme($scheme) {
      $this->scheme = strtolower($scheme);
      return $this;
    }


    /**
     * @return string
     */
    public function getMethod() {
      return $this->method;
    }


    /**
     * @param string|\string[] $method
     *
     * @return $this
     */
    public function setMethod($method) {
      $this->method = strtolower($method);
      return $this;
    }
  }

1		<?php
2
3		namespace ReRoute\Template;
4
5		use ReRoute\ParameterStore;
6		use ReRoute\RequestContext;
7		use ReRoute\Url;
8		use ReRoute\UrlBuilder;
9
10		/**
11		* @package ReRoute\Template
12		*/
13		class UrlTemplate {
14
15		use ParameterStore;
16
17		CONST PARAMETER_SCHEME = 'scheme';
18
19		CONST PARAMETER_HOST = 'host';
20
21		CONST PARAMETER_PATH = 'path';
22
23		CONST PARAMETER_METHOD = 'method';
24
25
26		/**
27		* @var Template
28		*/
29		protected $pathTemplate = null;
30
31
32		/**
33		* @var Template
34		*/
35		protected $hostTemplate = null;
36
37
38		/**
39		* @var string
40		*/
41		protected $scheme = null;
42
43
44		/**
45		* @var string
46		*/
47		protected $method = null;
48
49
50		/**
51		* UrlTemplate constructor.
52		* @param array $parameters
53		* @throws \InvalidArgumentException
54		*/
55	120	public function __construct(array $parameters = []) {
56	120	foreach ($parameters as $key => $value) {
57	102	if ($key == self::PARAMETER_METHOD) {
58	39	$this->setMethod($value);
59	39	continue;
60		}
61	102	if ($key == self::PARAMETER_SCHEME) {
62	69	$this->setScheme($value);
63	69	continue;
64		}
65	102	if ($key == self::PARAMETER_HOST) {
66	90	$this->setHostTemplate($value);
67	90	continue;
68		}
69	93	if ($key == self::PARAMETER_PATH) {
70	90	$this->setPathTemplate($value);
71	90	continue;
72		}
73
74	3	throw new \InvalidArgumentException('Unsupported parameter: ' . $key);
75	117	}
76	117	}
77
78
79		/**
80		* @param RequestContext $requestContext
81		* @return bool
82		*/
83	90	public function isMatched(RequestContext $requestContext) {
84	90	if (!empty($this->pathTemplate)) {
85	78	if ($this->pathTemplate->match($requestContext->getPath(), $matchedParams)) {
86	66	$this->storeDefaultParameters($matchedParams);
		0 ignored issues – show Documentation introduced 2016-04-28 11:13 UTC by Report Bug Copy Issue Report `$matchedParams` is of type `null`, but the function expects a `array`. 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...
87	66	} else {
88	24	return false;
89		}
90	66	}
91
92	84	if (!empty($this->hostTemplate)) {
93	75	if ($this->hostTemplate->match($requestContext->getHost(), $matchedParams)) {
94	54	$this->storeParameters($matchedParams);
		0 ignored issues – show Documentation introduced 2016-04-28 11:13 UTC by Report Bug Copy Issue Report `$matchedParams` is of type `null`, but the function expects a `array`. 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...
95	54	} else {
96	33	return false;
97		}
98	54	}
99
100	63	if (!empty($this->scheme)) {
101	36	if (!in_array($requestContext->getScheme(), explode('\|', $this->scheme))) {
102	6	return false;
103		}
104	33	}
105
106	60	if (!empty($this->method)) {
107	24	if (!in_array(strtolower($requestContext->getMethod()), explode('\|', $this->method))) {
108	9	return false;
109		}
110	18	}
111
112	54	return true;
113		}
114
115
116		/**
117		* @param Url $url
118		* @param UrlBuilder $urlBuilder
119		*/
120	27	public function build(Url $url, UrlBuilder $urlBuilder) {
121	27	if (!empty($this->hostTemplate)) {
122	24	$url->setHost($this->templateBuild($this->hostTemplate, $urlBuilder));
123	24	}
124
125	27	if (!empty($this->pathTemplate)) {
126	27	$url->setPath($this->templateBuild($this->pathTemplate, $urlBuilder));
127	24	}
128
129	27	if (!empty($this->scheme)) {
130	18	$url->setScheme($this->scheme);
131	18	}
132	27	}
133
134
135		/**
136		* @param Template $template
137		* @param UrlBuilder $urlBuilder
138		* @return string
139		*/
140	27	protected function templateBuild(Template $template, UrlBuilder $urlBuilder) {
141
142
143	27	$path = $template->build($urlBuilder->getAllParameters(), $usedParameters);
144	27	foreach ($usedParameters as $name) {
		0 ignored issues – show Bug introduced 2016-04-28 11:13 UTC by Report Bug Copy Issue Report The expression `$usedParameters` of type `array\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
145	9	$urlBuilder->useParameter($name);
146	27	}
147
148	27	return $path;
149		}
150
151
152		/**
153		* @return Template
154		*/
155	6	public function getPathTemplate() {
156	6	return $this->pathTemplate;
157		}
158
159
160		/**
161		* @param string $pathTemplate
162		*
163		* @return $this
164		*/
165	111	public function setPathTemplate($pathTemplate) {
166	111	if (is_string($pathTemplate)) {
167	111	$this->pathTemplate = new Template($pathTemplate);
168	111	} elseif ($pathTemplate instanceof Template) {
169		$this->pathTemplate = $pathTemplate;
170		} else {
171		throw new \InvalidArgumentException("Invalid pathTemplate parameter. Expect string or instance of Template. Given:" . gettype($pathTemplate));
172		}
173
174	111	return $this;
175		}
176
177
178		/**
179		* @return Template
180		*/
181	6	public function getHostTemplate() {
182	6	return $this->hostTemplate;
183		}
184
185
186		/**
187		* @param string $hostTemplate
188		*
189		* @return $this
190		*/
191	108	public function setHostTemplate($hostTemplate) {
192	108	if (is_string($hostTemplate)) {
193	108	$this->hostTemplate = new Template($hostTemplate);
194	108	} elseif ($hostTemplate instanceof Template) {
195		$this->hostTemplate = $hostTemplate;
196		} else {
197		throw new \InvalidArgumentException("Invalid hostTemplate parameter. Expect string or instance of Template. Given:" . gettype($hostTemplate));
198		}
199
200	108	return $this;
201		}
202
203
204		/**
205		* @return string
206		*/
207	6	public function getScheme() {
208	6	return $this->scheme;
209		}
210
211
212		/**
213		* @param string\|\string[] $scheme
214		*
215		* @return $this
216		*/
217	90	public function setScheme($scheme) {
218	90	$this->scheme = strtolower($scheme);
219	90	return $this;
220		}
221
222
223		/**
224		* @return string
225		*/
226	6	public function getMethod() {
227	6	return $this->method;
228		}
229
230
231		/**
232		* @param string\|\string[] $method
233		*
234		* @return $this
235		*/
236	45	public function setMethod($method) {
237	45	$this->method = strtolower($method);
238	45	return $this;
239		}
240		}

shakhraj / ReRoute

UrlTemplate::templateBuild() A last analyzed 2016-04-28 14:34 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

UrlTemplate::templateBuild() A
last analyzed 2016-04-28 14:34 UTC