Header::newInstance() - Code Metrics - Inspection of "Daily Inspection: Close #114" - neomerx/json-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (85eed3)

unknown

created 2016-03-17 00:59 UTC

Header::newInstance() A

↳ Parent: Header

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php namespace Neomerx\JsonApi\Http\Headers;

/**
 * Copyright 2015 [email protected] (www.neomerx.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use \InvalidArgumentException;
use \Neomerx\JsonApi\Contracts\Http\Headers\HeaderInterface;
use \Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface;

/**
 * @package Neomerx\JsonApi
 */
class Header implements HeaderInterface
{
    /**
     * @var string
     */
    private $name;

    /**
     * @var MediaTypeInterface[]
     */
    private $mediaTypes;

    /**
     * @param string               $name
     * @param MediaTypeInterface[] $mediaTypes
     */
    public function __construct($name, $mediaTypes)
    {
        $name = trim($name);
        if (empty($name) === true) {
            throw new InvalidArgumentException('name');
        }

        if (is_array($mediaTypes) === false) {
            throw new InvalidArgumentException('mediaTypes');
        }

        $this->name       = $name;
        $this->mediaTypes = $mediaTypes;
    }

    /**
     * @inheritdoc
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @inheritdoc
     */
    public function getMediaTypes()
    {
        return $this->mediaTypes;
    }

    /**
     * Parse header.
     *
     * @param string $header
     * @param string $name
     *
     * @return HeaderInterface

     */
    public static function parse($header, $name)
    {
        if (is_string($name) === false || empty($name) === true) {
            throw new InvalidArgumentException('header');
        }

        $mediaTypes = [];
        $ranges     = preg_split("/,(?=([^\"]*\"[^\"]*\")*[^\"]*$)/", $header);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        $count      = count($ranges);
        for ($idx = 0; $idx < $count; ++$idx) {
            $mediaTypes[] = static::parseMediaType($idx, $ranges[$idx]);
        }

        return static::newInstance($name, $mediaTypes);
    }

    /**
     * @param int    $position
     * @param string $mediaType
     *
     * @return MediaTypeInterface

     */
    protected static function parseMediaType($position, $mediaType)
    {
        return MediaType::parse($position, $mediaType);
    }

    /**
     * @param string               $name
     * @param MediaTypeInterface[] $mediaTypes
     *
     * @return Header
     */
    protected static function newInstance($name, $mediaTypes)
    {
        return new static($name, $mediaTypes);
    }
}


1		<?php namespace Neomerx\JsonApi\Http\Headers;
2
3		/**
4		* Copyright 2015 [email protected] (www.neomerx.com)
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License");
7		* you may not use this file except in compliance with the License.
8		* You may obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS,
14		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15		* See the License for the specific language governing permissions and
16		* limitations under the License.
17		*/
18
19		use \InvalidArgumentException;
20		use \Neomerx\JsonApi\Contracts\Http\Headers\HeaderInterface;
21		use \Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface;
22
23		/**
24		* @package Neomerx\JsonApi
25		*/
26		class Header implements HeaderInterface
27		{
28		/**
29		* @var string
30		*/
31		private $name;
32
33		/**
34		* @var MediaTypeInterface[]
35		*/
36		private $mediaTypes;
37
38		/**
39		* @param string $name
40		* @param MediaTypeInterface[] $mediaTypes
41		*/
42	53	public function __construct($name, $mediaTypes)
43		{
44	53	$name = trim($name);
45	53	if (empty($name) === true) {
46	1	throw new InvalidArgumentException('name');
47		}
48
49	52	if (is_array($mediaTypes) === false) {
50	1	throw new InvalidArgumentException('mediaTypes');
51		}
52
53	51	$this->name = $name;
54	51	$this->mediaTypes = $mediaTypes;
55	51	}
56
57		/**
58		* @inheritdoc
59		*/
60	2	public function getName()
61	1	{
62	2	return $this->name;
63		}
64
65		/**
66		* @inheritdoc
67		*/
68	40	public function getMediaTypes()
69		{
70	40	return $this->mediaTypes;
71		}
72
73		/**
74		* Parse header.
75		*
76		* @param string $header
77		* @param string $name
78		*
79		* @return HeaderInterface
		1 ignored issue – show Documentation introduced 2016-03-16 01:05 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `Header`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
80		*/
81	55	public static function parse($header, $name)
82		{
83	55	if (is_string($name) === false \|\| empty($name) === true) {
84	1	throw new InvalidArgumentException('header');
85		}
86
87	54	$mediaTypes = [];
88	54	$ranges = preg_split("/,(?=([^\"]\"[^\"]\")[^\"]$)/", $header);
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-03-16 01:05 UTC by Report Bug Copy Issue Report The string literal `/,(?=([^\"]\"[^\"]\")[^\"]$)/` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
89	54	$count = count($ranges);
90	54	for ($idx = 0; $idx < $count; ++$idx) {
91	54	$mediaTypes[] = static::parseMediaType($idx, $ranges[$idx]);
92	50	}
93
94	50	return static::newInstance($name, $mediaTypes);
95		}
96
97		/**
98		* @param int $position
99		* @param string $mediaType
100		*
101		* @return MediaTypeInterface
		1 ignored issue – show Documentation introduced 2016-03-16 01:05 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `MediaType`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
102		*/
103	37	protected static function parseMediaType($position, $mediaType)
104		{
105	37	return MediaType::parse($position, $mediaType);
106		}
107
108		/**
109		* @param string $name
110		* @param MediaTypeInterface[] $mediaTypes
111		*
112		* @return Header
113		*/
114	36	protected static function newInstance($name, $mediaTypes)
115		{
116	36	return new static($name, $mediaTypes);
117		}
118		}
119

neomerx / json-api

Branch — master (85eed3)

Header::newInstance() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like