ImageCandidateSet::sortImageCandidates() - Code Metrics - Inspection of "Complete application tests" - jkphl/responsive-images-css - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 044ff8...91a8e4 )

by Joschi

created 2018-04-01 15:55 UTC

ImageCandidateSet::sortImageCandidates() A

↳ Parent: ImageCandidateSet

Complexity

Conditions	3
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	3

Importance

Changes

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

<?php

/**
 * responsive-images-css
 *
 * @category   Jkphl
 * @package    Jkphl\Respimgcss
 * @subpackage Jkphl\Respimgcss\Application\Model
 * @author     Joschi Kuphal <[email protected]> / @jkphl
 * @copyright  Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
 * @license    http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Jkphl\Respimgcss\Application\Model;

use Jkphl\Respimgcss\Application\Contract\ImageCandidateSetInterface;
use Jkphl\Respimgcss\Application\Exceptions\InvalidArgumentException;
use Jkphl\Respimgcss\Domain\Contract\ImageCandidateInterface;

/**
 * Typed and validating image candidate set
 *
 * @package    Jkphl\Respimgcss
 * @subpackage Jkphl\Respimgcss\Application
 */
class ImageCandidateSet extends \Jkphl\Respimgcss\Domain\Model\ImageCandidateSet implements ImageCandidateSetInterface
{
    /**
     * Image candidate set type
     *
     * @var string
     */
    protected $type = null;
    /**
     * Image candidate values
     *
     * @var array
     */
    protected $values = [];

    /**
     * Image candidate set constructor
     *
     * @param ImageCandidateInterface $imageCandidate Image candidate
     */
    public function __construct(ImageCandidateInterface $imageCandidate)
    {
        $this->type                                = $imageCandidate->getType();
        $this->imageCandidates[]                   = $imageCandidate;
        $this->values[$imageCandidate->getValue()] = true;
    }

    /**
     * Offset to set
     *
     * @param int $offset Offset
     * @param ImageCandidateInterface $value
     *
     * @return void
     * @throws InvalidArgumentException If the value given is not a valid image candidate
     * @throws InvalidArgumentException If the image candidate types are inconsistent
     * @throws InvalidArgumentException If the image candidate value isn't unique
     */
    public function offsetSet($offset, $value): void
    {
        if (!($value instanceof ImageCandidateInterface)) {
            throw new InvalidArgumentException(
                InvalidArgumentException::INVALID_IMAGE_CANDIDATE_STR,
                InvalidArgumentException::INVALID_IMAGE_CANDIDATE
            );
        }

        // Test if the image candidate type matches the current set type
        if ($value->getType() !== $this->type) {
            throw new InvalidArgumentException(
                InvalidArgumentException::INCONSISTENT_IMAGE_CANDIDATE_TYPES_STR,
                InvalidArgumentException::INCONSISTENT_IMAGE_CANDIDATE_TYPES
            );
        }

        if (array_key_exists($value->getValue(), $this->values)) {
            throw new InvalidArgumentException(
                sprintf(InvalidArgumentException::OVERLAPPING_IMAGE_CANDIDATE_VALUE_STR, $value),
                InvalidArgumentException::OVERLAPPING_IMAGE_CANDIDATE_VALUE
            );
        }

        parent::offsetSet($offset, $value);
        $this->values[$value->getValue()] = true;

        // Sort the image candidates by value
        usort($this->imageCandidates, [$this, 'sortImageCandidates']);
    }

    /**
     * Compare and sort two image candidates by value
     *
     * @param ImageCandidateInterface $image1 Image candidate 1
     * @param ImageCandidateInterface $image2 Image candidate 2
     *
     * @return int
     */
    protected function sortImageCandidates(ImageCandidateInterface $image1, ImageCandidateInterface $image2): int
    {
        $imageValue1 = $image1->getValue();
        $imageValue2 = $image2->getValue();

        return ($imageValue1 === $imageValue2) ?: (($imageValue1 > $imageValue2) ? 1 : -1);

    }

    /**
     * Return all image candidates as an array
     *
     * @return array Image candidates
     */
    public function toArray(): array
    {
        return $this->imageCandidates;
    }

    /**
     * Return the image candidate set type
     *
     * @return string|null Image candidate set type
     */
    public function getType(): string
    {
        return $this->type;
    }
}

1		<?php
2
3		/**
4		* responsive-images-css
5		*
6		* @category Jkphl
7		* @package Jkphl\Respimgcss
8		* @subpackage Jkphl\Respimgcss\Application\Model
9		* @author Joschi Kuphal <[email protected]> / @jkphl
10		* @copyright Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
11		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12		*/
13
14		/***********************************************************************************
15		* The MIT License (MIT)
16		*
17		* Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
18		*
19		* Permission is hereby granted, free of charge, to any person obtaining a copy of
20		* this software and associated documentation files (the "Software"), to deal in
21		* the Software without restriction, including without limitation the rights to
22		* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23		* the Software, and to permit persons to whom the Software is furnished to do so,
24		* subject to the following conditions:
25		*
26		* The above copyright notice and this permission notice shall be included in all
27		* copies or substantial portions of the Software.
28		*
29		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31		* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32		* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33		* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34		* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35		***********************************************************************************/
36
37		namespace Jkphl\Respimgcss\Application\Model;
38
39		use Jkphl\Respimgcss\Application\Contract\ImageCandidateSetInterface;
40		use Jkphl\Respimgcss\Application\Exceptions\InvalidArgumentException;
41		use Jkphl\Respimgcss\Domain\Contract\ImageCandidateInterface;
42
43		/**
44		* Typed and validating image candidate set
45		*
46		* @package Jkphl\Respimgcss
47		* @subpackage Jkphl\Respimgcss\Application
48		*/
49		class ImageCandidateSet extends \Jkphl\Respimgcss\Domain\Model\ImageCandidateSet implements ImageCandidateSetInterface
50		{
51		/**
52		* Image candidate set type
53		*
54		* @var string
55		*/
56		protected $type = null;
57		/**
58		* Image candidate values
59		*
60		* @var array
61		*/
62		protected $values = [];
63
64		/**
65		* Image candidate set constructor
66		*
67		* @param ImageCandidateInterface $imageCandidate Image candidate
68		*/
69	8	public function __construct(ImageCandidateInterface $imageCandidate)
70		{
71	8	$this->type = $imageCandidate->getType();
72	8	$this->imageCandidates[] = $imageCandidate;
73	8	$this->values[$imageCandidate->getValue()] = true;
74	8	}
75
76		/**
77		* Offset to set
78		*
79		* @param int $offset Offset
80		* @param ImageCandidateInterface $value
81		*
82		* @return void
83		* @throws InvalidArgumentException If the value given is not a valid image candidate
84		* @throws InvalidArgumentException If the image candidate types are inconsistent
85		* @throws InvalidArgumentException If the image candidate value isn't unique
86		*/
87	4	public function offsetSet($offset, $value): void
88		{
89	4	if (!($value instanceof ImageCandidateInterface)) {
90	1	throw new InvalidArgumentException(
91	1	InvalidArgumentException::INVALID_IMAGE_CANDIDATE_STR,
92	1	InvalidArgumentException::INVALID_IMAGE_CANDIDATE
93		);
94		}
95
96		// Test if the image candidate type matches the current set type
97	3	if ($value->getType() !== $this->type) {
98	1	throw new InvalidArgumentException(
99	1	InvalidArgumentException::INCONSISTENT_IMAGE_CANDIDATE_TYPES_STR,
100	1	InvalidArgumentException::INCONSISTENT_IMAGE_CANDIDATE_TYPES
101		);
102		}
103
104	3	if (array_key_exists($value->getValue(), $this->values)) {
105	1	throw new InvalidArgumentException(
106	1	sprintf(InvalidArgumentException::OVERLAPPING_IMAGE_CANDIDATE_VALUE_STR, $value),
107	1	InvalidArgumentException::OVERLAPPING_IMAGE_CANDIDATE_VALUE
108		);
109		}
110
111	2	parent::offsetSet($offset, $value);
112	2	$this->values[$value->getValue()] = true;
113
114		// Sort the image candidates by value
115	2	usort($this->imageCandidates, [$this, 'sortImageCandidates']);
116	2	}
117
118		/**
119		* Compare and sort two image candidates by value
120		*
121		* @param ImageCandidateInterface $image1 Image candidate 1
122		* @param ImageCandidateInterface $image2 Image candidate 2
123		*
124		* @return int
125		*/
126	2	protected function sortImageCandidates(ImageCandidateInterface $image1, ImageCandidateInterface $image2): int
127		{
128	2	$imageValue1 = $image1->getValue();
129	2	$imageValue2 = $image2->getValue();
130
131	2	return ($imageValue1 === $imageValue2) ?: (($imageValue1 > $imageValue2) ? 1 : -1);
		0 ignored issues – show Bug Best Practice introduced 2018-04-01 15:57 UTC by Report Bug Copy Issue Report The expression `return $imageValue1 === ...> $imageValue2 ? 1 : -1` could return the type `true` which is incompatible with the type-hinted return `integer`. Consider adding an additional type-check to rule them out. Loading history...
132		}
133
134		/**
135		* Return all image candidates as an array
136		*
137		* @return array Image candidates
138		*/
139	2	public function toArray(): array
140		{
141	2	return $this->imageCandidates;
142		}
143
144		/**
145		* Return the image candidate set type
146		*
147		* @return string\|null Image candidate set type
148		*/
149	5	public function getType(): string
150		{
151	5	return $this->type;
152		}
153		}

jkphl / responsive-images-css

Push — master ( 044ff8...91a8e4 )

ImageCandidateSet::sortImageCandidates() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like