FileService - Code Metrics - Inspection of "Merge branch 'develop'" - jenskooij/cloudcontrol - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b91050...6fb96f )

by Jens

created 2017-10-12 13:33 UTC

FileService A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	63
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	63
loc	63
rs	10
c	1
b	0
f	0
wmc	7
lcom	1
cbo	3

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	2	2	1
A	getInstance()	7	7	2
A	get()	5	5	1
A	__toString()	4	4	1
A	getFileByPath()	5	5	1
A	init()	4	4	1

How to fix Duplicated Code

<?php
/**
 * Created by jensk on 12-10-2017.
 */

namespace CloudControl\Cms\services;
use CloudControl\Cms\storage\entities\File;
use CloudControl\Cms\storage\Storage;

/**
 * Class FileService
 * Singleton
 *
 * @package CloudControl\Cms\services
 */
class FileService

{
    private static $instance;
    /**
     * @var Storage
     */
    protected $storage;

    /**
     * FileService constructor.
     */
    protected function __construct()
    {}

    /**
     * @return FileService
     */
    public static function getInstance()
    {
        if (!self::$instance instanceof FileService) {
            self::$instance = new FileService();
        }
        return self::$instance;
    }

    /**
     * @param $filePath
     * @return File
     */
    public static function get($filePath)
    {
        $instance = self::getInstance();
        return $instance->getFileByPath($filePath);
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return print_r(self::$instance, true);
    }

    /**
     * @param $filePath
     * @return File
     */
    protected function getFileByPath($filePath)
    {
        $file = $this->storage->getFiles()->getFileByName($filePath);
        return new File($file);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    /**
     * @param Storage $storage
     */
    public function init(Storage $storage)
    {
        $this->storage = $storage;
    }


}

1		<?php
2		/**
3		* Created by jensk on 12-10-2017.
4		*/
5
6		namespace CloudControl\Cms\services;
7		use CloudControl\Cms\storage\entities\File;
8		use CloudControl\Cms\storage\Storage;
9
10		/**
11		* Class FileService
12		* Singleton
13		*
14		* @package CloudControl\Cms\services
15		*/
16	View Code Duplication	class FileService
		0 ignored issues – show Duplication introduced 2017-10-12 09:43 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
17		{
18		private static $instance;
19		/**
20		* @var Storage
21		*/
22		protected $storage;
23
24		/**
25		* FileService constructor.
26		*/
27		protected function __construct()
28		{}
29
30		/**
31		* @return FileService
32		*/
33		public static function getInstance()
34		{
35		if (!self::$instance instanceof FileService) {
36		self::$instance = new FileService();
37		}
38		return self::$instance;
39		}
40
41		/**
42		* @param $filePath
43		* @return File
44		*/
45		public static function get($filePath)
46		{
47		$instance = self::getInstance();
48		return $instance->getFileByPath($filePath);
49		}
50
51		/**
52		* @return string
53		*/
54		public function __toString()
55		{
56		return print_r(self::$instance, true);
57		}
58
59		/**
60		* @param $filePath
61		* @return File
62		*/
63		protected function getFileByPath($filePath)
64		{
65		$file = $this->storage->getFiles()->getFileByName($filePath);
66		return new File($file);
		0 ignored issues – show Bug introduced 2017-10-12 11:18 UTC by Report Bug Copy Issue Report It seems like `$file` defined by `$this->storage->getFiles...etFileByName($filePath)` on line `65` can be `null`; however, `CloudControl\Cms\storage...ies\File::__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
67		}
68
69		/**
70		* @param Storage $storage
71		*/
72		public function init(Storage $storage)
73		{
74		$this->storage = $storage;
75		}
76
77
78		}

jenskooij / cloudcontrol

Push — master ( b91050...6fb96f )

FileService A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like