IndexAwareTrait::setIndex() - Code Metrics - Inspection of "* More robust error conditions handling" - Maslosoft/Manganel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6e3b43...934df1 )

by Peter

created 2018-07-05 18:53 UTC

IndexAwareTrait::setIndex() A

↳ Parent: IndexAwareTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

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

<?php

/**
 * This software package is licensed under `AGPL-3.0-only, proprietary` license[s].
 *
 * @package maslosoft/manganel
 * @license AGPL-3.0-only, proprietary
 *
 * @copyright Copyright (c) Peter Maselkowski <[email protected]>
 * @link https://maslosoft.com/manganel/
 */

namespace Maslosoft\Manganel\Traits;

use Maslosoft\Manganel\Interfaces\IndexAwareInterface;
use UnexpectedValueException;

/**
 * IndexAwareTrait
 *
 * @author Piotr Maselkowski <pmaselkowski at gmail.com>
 */
trait IndexAwareTrait
{

	private $index = '';

	/**
	 * Get currently used index
	 * @return string
	 */
	public function getIndex()
	{
		if (!$this instanceof IndexAwareInterface)
		{
			throw new UnexpectedValueException(sprintf('Class `%s` using `%s` must implement `%s`', get_class($this), __CLASS__, IndexAwareInterface::class)); // @codeCoverageIgnore
		}
		return $this->index;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
	}

	/**
	 * Set currently used index
	 * @param string $index
	 * @return static
	 */
	public function setIndex($index)
	{
		if (!$this instanceof IndexAwareInterface)
		{
			throw new UnexpectedValueException(sprintf('Class `%s` using `%s` must implement `%s`', get_class($this), __CLASS__, IndexAwareInterface::class)); // @codeCoverageIgnore
		}
		$this->index = $index;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
		return $this;
	}

}


1			<?php
2
3			/**
4			* This software package is licensed under `AGPL-3.0-only, proprietary` license[s].
5			*
6			* @package maslosoft/manganel
7			* @license AGPL-3.0-only, proprietary
8			*
9			* @copyright Copyright (c) Peter Maselkowski <[email protected]>
10			* @link https://maslosoft.com/manganel/
11			*/
12
13			namespace Maslosoft\Manganel\Traits;
14
15			use Maslosoft\Manganel\Interfaces\IndexAwareInterface;
16			use UnexpectedValueException;
17
18			/**
19			* IndexAwareTrait
20			*
21			* @author Piotr Maselkowski <pmaselkowski at gmail.com>
22			*/
23			trait IndexAwareTrait
24			{
25
26			private $index = '';
27
28			/**
29			* Get currently used index
30			* @return string
31			*/
32			public function getIndex()
33			{
34			if (!$this instanceof IndexAwareInterface)
35			{
36			throw new UnexpectedValueException(sprintf('Class `%s` using `%s` must implement `%s`', get_class($this), __CLASS__, IndexAwareInterface::class)); // @codeCoverageIgnore
37			}
38			return $this->index;
			0 ignored issues – show Bug introduced 2016-08-04 13:25 UTC by Report Bug Copy Issue Report Accessing `index` on the interface `Maslosoft\Manganel\Interfaces\IndexAwareInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
39			}
40
41			/**
42			* Set currently used index
43			* @param string $index
44			* @return static
45			*/
46			public function setIndex($index)
47			{
48			if (!$this instanceof IndexAwareInterface)
49			{
50			throw new UnexpectedValueException(sprintf('Class `%s` using `%s` must implement `%s`', get_class($this), __CLASS__, IndexAwareInterface::class)); // @codeCoverageIgnore
51			}
52			$this->index = $index;
			0 ignored issues – show Bug introduced 2016-08-04 13:25 UTC by Report Bug Copy Issue Report Accessing `index` on the interface `Maslosoft\Manganel\Interfaces\IndexAwareInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
53			return $this;
54			}
55
56			}
57

Maslosoft / Manganel

Push — master ( 6e3b43...934df1 )

IndexAwareTrait::setIndex() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like