Result - Code Metrics - duoshuo/php-cassandra - Measure and Improve Code Quality continuously with Scrutinizer

Result C
last analyzed 2015-12-16 12:25 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	309
Duplicated Lines	1.29 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	25
Bugs	6	Features	5

Metric	Value
wmc	55
c	25
b	6
f	5
lcom	1
cbo	2
dl	4
loc	309
rs	6.8

11 Methods

Rating	Name	Duplication	Size	Complexity
B	getData()	0	29	6
A	getKind()	0	8	2
A	setMetadata()	0	5	1
A	getMetadata()	0	8	2
A	setRowClass()	0	5	1
B	_readMetadata()	0	40	6
C	fetchAll()	2	27	8
C	fetchCol()	0	25	7
C	fetchPairs()	0	29	8
C	fetchRow()	2	24	8
B	fetchOne()	0	20	6

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Result often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Result, and based on these observations, apply Extract Interface, too.

<?php 
namespace Cassandra\Response;
use Cassandra\Protocol\Frame;
use Cassandra\Type;

class Result extends Response {
    const VOID = 0x0001;
    const ROWS = 0x0002;
    const SET_KEYSPACE = 0x0003;
    const PREPARED = 0x0004;
    const SCHEMA_CHANGE = 0x0005;
    
    const ROWS_FLAG_GLOBAL_TABLES_SPEC = 0x0001;
    const ROWS_FLAG_HAS_MORE_PAGES = 0x0002;
    const ROWS_FLAG_NO_METADATA = 0x0004;
    
    /**
     * 
     * @var int
     */
    protected $_kind;
    
    /**
     * 
     * @var array
     */
    protected $_metadata;
    
    /**
     * 
     * @var string
     */
    protected $_rowClass;

    /**
     * @return \SplFixedArray|string|array|null
     */
    public function getData() {
        $this->_stream->offset(4);
        switch($this->getKind()) {
            case self::VOID:
                return null;
    
            case self::ROWS:
                return $this->fetchAll();
    
            case self::SET_KEYSPACE:
                return $this->_stream->readString();
    
            case self::PREPARED:
                return [
                    'id' => $this->_stream->readString(),
                    'metadata' => $this->_readMetadata(),
                    'result_metadata' => $this->_readMetadata(),
                ];
    
            case self::SCHEMA_CHANGE:
                return [
                    'change' => $this->_stream->readString(),
                    'keyspace' => $this->_stream->readString(),
                    'table' => $this->_stream->readString()
                ];
        }
    
        return null;
    }
    
    public function getKind(){
        if ($this->_kind === null){
            $this->_stream->offset(0);
            $this->_kind = $this->_stream->readInt();
        }
        
        return $this->_kind;
    }

    /**
     * 
     * @param array $metadata
     * @return self
     */
    public function setMetadata(array $metadata) {
        $this->_metadata = $metadata;
        
        return $this;
    }
    
    /**
     * 
     * @return array
     */
    public function getMetadata(){
        if (empty($this->_metadata)){
            $this->_stream->offset(4);
            $this->_metadata = $this->_readMetadata();
        }
        
        return $this->_metadata;
    }
    
    /**
     * 
     * @param string $rowClass
     * @return self
     */
    public function setRowClass($rowClass) {
        $this->_rowClass = $rowClass;
    
        return $this;
    }
    
    /**
     * Return metadata
     * @return array
     */
    protected function _readMetadata() {
        $metadata = [
            'flags' => $this->_stream->readInt(),
            'columns_count' => $this->_stream->readInt(),
        ];
        $flags = $metadata['flags'];

        if ($flags & self::ROWS_FLAG_HAS_MORE_PAGES)
            $metadata['page_state'] = $this->_stream->readBytes();

        if (!($flags & self::ROWS_FLAG_NO_METADATA)) {
            $metadata['columns'] = [];
            
            if ($flags & self::ROWS_FLAG_GLOBAL_TABLES_SPEC) {
                $keyspace = $this->_stream->readString();
                $tableName = $this->_stream->readString();

                for ($i = 0; $i < $metadata['columns_count']; ++$i) {
                    $metadata['columns'][] = [
                        'keyspace' => $keyspace,
                        'tableName' => $tableName,
                        'name' => $this->_stream->readString(),
                        'type' => $this->_stream->readType()
                    ];
                }
            }
            else {
                for ($i = 0; $i < $metadata['columns_count']; ++$i) {
                    $metadata['columns'][] = [
                        'keyspace' => $this->_stream->readString(),
                        'tableName' => $this->_stream->readString(),
                        'name' => $this->_stream->readString(),
                        'type' => $this->_stream->readType()
                    ];
                }
            }
        }
    
        return $metadata;
    }
    
    /**
     *
     * @param string $rowClass
     * @throws Exception
     * @return \SplFixedArray
     */
    public function fetchAll($rowClass = null){
        if ($this->getKind() !== self::ROWS){
            throw new Exception('Unexpected Response: ' . $this->getKind());
        }
        $this->_stream->offset(4);
        $this->_metadata = $this->_metadata ? array_merge($this->_metadata, $this->_readMetadata()) : $this->_readMetadata();

        if (!isset($this->_metadata['columns']))
            throw new Exception('Missing Result Metadata');

        $rowCount = $this->_stream->readInt();
        $rows = new \SplFixedArray($rowCount);
        
        if ($rowClass === null)
            $rowClass = $this->_rowClass;
    
        for ($i = 0; $i < $rowCount; ++$i) {
            $data = [];
    
            foreach ($this->_metadata['columns'] as $column)

                $data[$column['name']] = $this->_stream->readValue($column['type']);
                
            $rows[$i] = $rowClass === null ? $data : new $rowClass($data);
        }
    
        return $rows;
    }

    /**
     *
     * @param int $index
     * @throws Exception
     * @return \SplFixedArray
     */
    public function fetchCol($index = 0){
        if ($this->getKind() !== self::ROWS){
            throw new Exception('Unexpected Response: ' . $this->getKind());
        }
        $this->_stream->offset(4);
        $this->_metadata = $this->_metadata ? array_merge($this->_metadata, $this->_readMetadata()) : $this->_readMetadata();

        if (!isset($this->_metadata['columns']))
            throw new Exception('Missing Result Metadata');

        $rowCount = $this->_stream->readInt();
    
        $array = new \SplFixedArray($rowCount);
    
        for($i = 0; $i < $rowCount; ++$i){
            foreach($this->_metadata['columns'] as $j => $column){
                $value = $this->_stream->readValue($column['type']);
    
                if ($j == $index)
                    $array[$i] = $value;
            }
        }
    
        return $array;
    }
    
    /**
     * 
     * @throws Exception
     * @return array
     */
    public function fetchPairs(){
        if ($this->getKind() !== self::ROWS){
            throw new Exception('Unexpected Response: ' . $this->getKind());
        }
        $this->_stream->offset(4);
        $this->_metadata = $this->_metadata ? array_merge($this->_metadata, $this->_readMetadata()) : $this->_readMetadata();
    
        if (!isset($this->_metadata['columns']))
            throw new Exception('Missing Result Metadata');
    
        $rowCount = $this->_stream->readInt();
    
        $map = [];
    
        for($i = 0; $i < $rowCount; ++$i){
            foreach($this->_metadata['columns'] as $j => $column){
                $value = $this->_stream->readValue($column['type']);
    
                if ($j === 0){
                    $key = $value;
                }
                elseif($j === 1){
                    $map[$key] = $value;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                }
            }
        }
    
        return $map;
    }
    
    /**
     *
     * @param string $rowClass
     * @throws Exception
     * @return \ArrayObject
     */
    public function fetchRow($rowClass = null){
        if ($this->getKind() !== self::ROWS){
            throw new Exception('Unexpected Response: ' . $this->getKind());
        }
        $this->_stream->offset(4);
        $this->_metadata = $this->_metadata ? array_merge($this->_metadata, $this->_readMetadata()) : $this->_readMetadata();

        if (!isset($this->_metadata['columns']))
            throw new Exception('Missing Result Metadata');

        $rowCount = $this->_stream->readInt();
    
        if ($rowCount === 0)
            return null;
    
        if ($rowClass === null)
            $rowClass = $this->_rowClass;
        
        $data = [];
        foreach ($this->_metadata['columns'] as $column)

            $data[$column['name']] = $this->_stream->readValue($column['type']);
    
        return $rowClass === null ? $data : new $rowClass($data);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
    
    /**
     *
     * @throws Exception
     * @return mixed
     */
    public function fetchOne(){
        if ($this->getKind() !== self::ROWS){
            throw new Exception('Unexpected Response: ' . $this->getKind());
        }
        $this->_stream->offset(4);
        $this->_metadata = $this->_metadata ? array_merge($this->_metadata, $this->_readMetadata()) : $this->_readMetadata();

        if (!isset($this->_metadata['columns']))
            throw new Exception('Missing Result Metadata');

        $rowCount = $this->_stream->readInt();
    
        if ($rowCount === 0)
            return null;
    
        foreach ($this->_metadata['columns'] as $column)
            return $this->_stream->readValue($column['type']);
    
        return null;
    }
}


1		<?php
2		namespace Cassandra\Response;
3		use Cassandra\Protocol\Frame;
4		use Cassandra\Type;
5
6		class Result extends Response {
7		const VOID = 0x0001;
8		const ROWS = 0x0002;
9		const SET_KEYSPACE = 0x0003;
10		const PREPARED = 0x0004;
11		const SCHEMA_CHANGE = 0x0005;
12
13		const ROWS_FLAG_GLOBAL_TABLES_SPEC = 0x0001;
14		const ROWS_FLAG_HAS_MORE_PAGES = 0x0002;
15		const ROWS_FLAG_NO_METADATA = 0x0004;
16
17		/**
18		*
19		* @var int
20		*/
21		protected $_kind;
22
23		/**
24		*
25		* @var array
26		*/
27		protected $_metadata;
28
29		/**
30		*
31		* @var string
32		*/
33		protected $_rowClass;
34
35		/**
36		* @return \SplFixedArray\|string\|array\|null
37		*/
38		public function getData() {
39		$this->_stream->offset(4);
40		switch($this->getKind()) {
41		case self::VOID:
42		return null;
43
44		case self::ROWS:
45		return $this->fetchAll();
46
47		case self::SET_KEYSPACE:
48		return $this->_stream->readString();
49
50		case self::PREPARED:
51		return [
52		'id' => $this->_stream->readString(),
53		'metadata' => $this->_readMetadata(),
54		'result_metadata' => $this->_readMetadata(),
55		];
56
57		case self::SCHEMA_CHANGE:
58		return [
59		'change' => $this->_stream->readString(),
60		'keyspace' => $this->_stream->readString(),
61		'table' => $this->_stream->readString()
62		];
63		}
64
65		return null;
66		}
67
68		public function getKind(){
69		if ($this->_kind === null){
70		$this->_stream->offset(0);
71		$this->_kind = $this->_stream->readInt();
72		}
73
74		return $this->_kind;
75		}
76
77		/**
78		*
79		* @param array $metadata
80		* @return self
81		*/
82		public function setMetadata(array $metadata) {
83		$this->_metadata = $metadata;
84
85		return $this;
86		}
87
88		/**
89		*
90		* @return array
91		*/
92		public function getMetadata(){
93		if (empty($this->_metadata)){
94		$this->_stream->offset(4);
95		$this->_metadata = $this->_readMetadata();
96		}
97
98		return $this->_metadata;
99		}
100
101		/**
102		*
103		* @param string $rowClass
104		* @return self
105		*/
106		public function setRowClass($rowClass) {
107		$this->_rowClass = $rowClass;
108
109		return $this;
110		}
111
112		/**
113		* Return metadata
114		* @return array
115		*/
116		protected function _readMetadata() {
117		$metadata = [
118		'flags' => $this->_stream->readInt(),
119		'columns_count' => $this->_stream->readInt(),
120		];
121		$flags = $metadata['flags'];
122
123		if ($flags & self::ROWS_FLAG_HAS_MORE_PAGES)
124		$metadata['page_state'] = $this->_stream->readBytes();
125
126		if (!($flags & self::ROWS_FLAG_NO_METADATA)) {
127		$metadata['columns'] = [];
128
129		if ($flags & self::ROWS_FLAG_GLOBAL_TABLES_SPEC) {
130		$keyspace = $this->_stream->readString();
131		$tableName = $this->_stream->readString();
132
133		for ($i = 0; $i < $metadata['columns_count']; ++$i) {
134		$metadata['columns'][] = [
135		'keyspace' => $keyspace,
136		'tableName' => $tableName,
137		'name' => $this->_stream->readString(),
138		'type' => $this->_stream->readType()
139		];
140		}
141		}
142		else {
143		for ($i = 0; $i < $metadata['columns_count']; ++$i) {
144		$metadata['columns'][] = [
145		'keyspace' => $this->_stream->readString(),
146		'tableName' => $this->_stream->readString(),
147		'name' => $this->_stream->readString(),
148		'type' => $this->_stream->readType()
149		];
150		}
151		}
152		}
153
154		return $metadata;
155		}
156
157		/**
158		*
159		* @param string $rowClass
160		* @throws Exception
161		* @return \SplFixedArray
162		*/
163		public function fetchAll($rowClass = null){
164		if ($this->getKind() !== self::ROWS){
165		throw new Exception('Unexpected Response: ' . $this->getKind());
166		}
167		$this->_stream->offset(4);
168		$this->_metadata = $this->_metadata ? array_merge($this->_metadata, $this->_readMetadata()) : $this->_readMetadata();
169
170		if (!isset($this->_metadata['columns']))
171		throw new Exception('Missing Result Metadata');
172
173		$rowCount = $this->_stream->readInt();
174		$rows = new \SplFixedArray($rowCount);
175
176		if ($rowClass === null)
177		$rowClass = $this->_rowClass;
178
179		for ($i = 0; $i < $rowCount; ++$i) {
180		$data = [];
181
182	View Code Duplication	foreach ($this->_metadata['columns'] as $column)
		0 ignored issues – show Duplication introduced 2015-12-04 15:29 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
183		$data[$column['name']] = $this->_stream->readValue($column['type']);
184
185		$rows[$i] = $rowClass === null ? $data : new $rowClass($data);
186		}
187
188		return $rows;
189		}
190
191		/**
192		*
193		* @param int $index
194		* @throws Exception
195		* @return \SplFixedArray
196		*/
197		public function fetchCol($index = 0){
198		if ($this->getKind() !== self::ROWS){
199		throw new Exception('Unexpected Response: ' . $this->getKind());
200		}
201		$this->_stream->offset(4);
202		$this->_metadata = $this->_metadata ? array_merge($this->_metadata, $this->_readMetadata()) : $this->_readMetadata();
203
204		if (!isset($this->_metadata['columns']))
205		throw new Exception('Missing Result Metadata');
206
207		$rowCount = $this->_stream->readInt();
208
209		$array = new \SplFixedArray($rowCount);
210
211		for($i = 0; $i < $rowCount; ++$i){
212		foreach($this->_metadata['columns'] as $j => $column){
213		$value = $this->_stream->readValue($column['type']);
214
215		if ($j == $index)
216		$array[$i] = $value;
217		}
218		}
219
220		return $array;
221		}
222
223		/**
224		*
225		* @throws Exception
226		* @return array
227		*/
228		public function fetchPairs(){
229		if ($this->getKind() !== self::ROWS){
230		throw new Exception('Unexpected Response: ' . $this->getKind());
231		}
232		$this->_stream->offset(4);
233		$this->_metadata = $this->_metadata ? array_merge($this->_metadata, $this->_readMetadata()) : $this->_readMetadata();
234
235		if (!isset($this->_metadata['columns']))
236		throw new Exception('Missing Result Metadata');
237
238		$rowCount = $this->_stream->readInt();
239
240		$map = [];
241
242		for($i = 0; $i < $rowCount; ++$i){
243		foreach($this->_metadata['columns'] as $j => $column){
244		$value = $this->_stream->readValue($column['type']);
245
246		if ($j === 0){
247		$key = $value;
248		}
249		elseif($j === 1){
250		$map[$key] = $value;
		0 ignored issues – show Bug introduced 2015-12-04 15:29 UTC by Report Bug Copy Issue Report The variable `$key` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
251		}
252		}
253		}
254
255		return $map;
256		}
257
258		/**
259		*
260		* @param string $rowClass
261		* @throws Exception
262		* @return \ArrayObject
263		*/
264		public function fetchRow($rowClass = null){
265		if ($this->getKind() !== self::ROWS){
266		throw new Exception('Unexpected Response: ' . $this->getKind());
267		}
268		$this->_stream->offset(4);
269		$this->_metadata = $this->_metadata ? array_merge($this->_metadata, $this->_readMetadata()) : $this->_readMetadata();
270
271		if (!isset($this->_metadata['columns']))
272		throw new Exception('Missing Result Metadata');
273
274		$rowCount = $this->_stream->readInt();
275
276		if ($rowCount === 0)
277		return null;
278
279		if ($rowClass === null)
280		$rowClass = $this->_rowClass;
281
282		$data = [];
283	View Code Duplication	foreach ($this->_metadata['columns'] as $column)
		0 ignored issues – show Duplication introduced 2015-12-04 15:29 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
284		$data[$column['name']] = $this->_stream->readValue($column['type']);
285
286		return $rowClass === null ? $data : new $rowClass($data);
		0 ignored issues – show Bug Best Practice introduced 2015-12-04 15:29 UTC by Report Bug Copy Issue Report The return type of `return $rowClass === nul...: new $rowClass($data);` (`array\|object`) is incompatible with the return type documented by `Cassandra\Response\Result::fetchRow` of type `ArrayObject\|null`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
287		}
288
289		/**
290		*
291		* @throws Exception
292		* @return mixed
293		*/
294		public function fetchOne(){
295		if ($this->getKind() !== self::ROWS){
296		throw new Exception('Unexpected Response: ' . $this->getKind());
297		}
298		$this->_stream->offset(4);
299		$this->_metadata = $this->_metadata ? array_merge($this->_metadata, $this->_readMetadata()) : $this->_readMetadata();
300
301		if (!isset($this->_metadata['columns']))
302		throw new Exception('Missing Result Metadata');
303
304		$rowCount = $this->_stream->readInt();
305
306		if ($rowCount === 0)
307		return null;
308
309		foreach ($this->_metadata['columns'] as $column)
310		return $this->_stream->readValue($column['type']);
311
312		return null;
313		}
314		}
315

duoshuo / php-cassandra

Result C last analyzed 2015-12-16 12:25 UTC