DataReader::read() - Code Metrics - edgardmessias/yii2-ibm-db2 - Measure and Improve Code Quality continuously with Scrutinizer

DataReader::read() A
last analyzed 2019-06-24 11:32 UTC

↳ Parent: DataReader

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

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

<?php

/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace edgardmessias\db\ibm\db2;

/**
 * @author Edgard Messias <[email protected]>
 * @since 1.0
 */
class DataReader extends \yii\db\DataReader
{

    /**
     * Advances the reader to the next row in a result set.
     * @return array the current row, false if no more row available
     */
    public function read()
    {
        //Try..Catch to prevent CLI0125E  Function sequence error. SQLSTATE=HY010
        try {
            return parent::read();
        } catch (\Exception $ex) {

        }
        return false;
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());
}
    }

    /**
     * Returns a single column from the next row of a result set.
     * @param integer $columnIndex zero-based column index
     * @return mixed the column of the current row, false if no more rows available
     */
    public function readColumn($columnIndex)
    {
        //Try..Catch to prevent CLI0125E  Function sequence error. SQLSTATE=HY010
        try {
            return parent::readColumn($columnIndex);
        } catch (\Exception $ex) {

        }
        return false;
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());
}
    }

    /**
     * Returns an object populated with the next row of data.
     * @param string $className class name of the object to be created and populated
     * @param array $fields Elements of this array are passed to the constructor
     * @return mixed the populated object, false if no more row of data available
     */
    public function readObject($className, $fields)
    {
        //Try..Catch to prevent CLI0125E  Function sequence error. SQLSTATE=HY010
        try {
            return parent::readObject($className, $fields);
        } catch (\Exception $ex) {

        }
        return false;
    }
}


1		<?php
2
3		/**
4		* @link http://www.yiiframework.com/
5		* @copyright Copyright (c) 2008 Yii Software LLC
6		* @license http://www.yiiframework.com/license/
7		*/
8
9		namespace edgardmessias\db\ibm\db2;
10
11		/**
12		* @author Edgard Messias <[email protected]>
13		* @since 1.0
14		*/
15		class DataReader extends \yii\db\DataReader
16		{
17
18		/**
19		* Advances the reader to the next row in a result set.
20		* @return array the current row, false if no more row available
21		*/
22	2	public function read()
23		{
24		//Try..Catch to prevent CLI0125E Function sequence error. SQLSTATE=HY010
25		try {
26	2	return parent::read();
27	2	} catch (\Exception $ex) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-04-29 19:57 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
28		}
29	2	return false;
		0 ignored issues – show Bug Best Practice introduced 2016-04-29 19:57 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type of the parent method `yii\db\DataReader::read` of type `array`. 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...
30		}
31
32		/**
33		* Returns a single column from the next row of a result set.
34		* @param integer $columnIndex zero-based column index
35		* @return mixed the column of the current row, false if no more rows available
36		*/
37		public function readColumn($columnIndex)
38		{
39		//Try..Catch to prevent CLI0125E Function sequence error. SQLSTATE=HY010
40		try {
41		return parent::readColumn($columnIndex);
42		} catch (\Exception $ex) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-04-29 19:57 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
43		}
44		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-04-29 19:57 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type of the parent method `yii\db\DataReader::readColumn` of type `string`. 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...
45		}
46
47		/**
48		* Returns an object populated with the next row of data.
49		* @param string $className class name of the object to be created and populated
50		* @param array $fields Elements of this array are passed to the constructor
51		* @return mixed the populated object, false if no more row of data available
52		*/
53		public function readObject($className, $fields)
54		{
55		//Try..Catch to prevent CLI0125E Function sequence error. SQLSTATE=HY010
56		try {
57		return parent::readObject($className, $fields);
58		} catch (\Exception $ex) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-04-29 19:57 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
59		}
60		return false;
61		}
62		}
63

edgardmessias / yii2-ibm-db2

DataReader::read() A last analyzed 2019-06-24 11:32 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

DataReader::read() A
last analyzed 2019-06-24 11:32 UTC