AbstractMigration::table() - Code Metrics - Inspection of "Updated the phpunit xml file to update for the new..." - PotatoPowered/potatobase - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — development (ef4cc3)

by Blake

created 2016-07-25 04:58 UTC

AbstractMigration::table() A

↳ Parent: AbstractMigration

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	2

<?php
/**
 * Potatobase (https://github.com/PotatoPowered/potatobase)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE
 * Redistributions of files must retain the above copyright notice.
 *
 * @author      Blake Sutton <[email protected]>
 * @copyright   Copyright (c) Potato Powered Software
 * @link        http://potatopowered.net
 * @since       0.0.1
 * @version     0.0.1
 * @license     http://www.opensource.org/licenses/mit-license.php MIT License
 */
namespace Potatobase\Migrations;

use Migrations\AbstractMigration as BaseAbstractMigration;
use Potatobase\DB\Table;

/**
 * Class AbstractMigration
 *
 * This class is an extension to the CakePHP AbstractMigration class that allows us to specify our own Table Class so
 * that we can use the new functionality that we have added.
 *
 * @package Potatobase\Migrations
 */
class AbstractMigration extends BaseAbstractMigration
{
    /**
     * Returns an instance of the <code>\Table</code> class.
     *
     * You can use this class to create and manipulate tables.
     *
     * @param string $tableName Table Name
     * @param array $options Options
     * @return Table
     */
    public function table($tableName, $options = [])
    {
        return new Table($tableName, $options, $this->getAdapter());
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());
}
    }
}


1			<?php
2			/**
3			* Potatobase (https://github.com/PotatoPowered/potatobase)
4			*
5			* Licensed under The MIT License
6			* For full copyright and license information, please see the LICENSE
7			* Redistributions of files must retain the above copyright notice.
8			*
9			* @author Blake Sutton <[email protected]>
10			* @copyright Copyright (c) Potato Powered Software
11			* @link http://potatopowered.net
12			* @since 0.0.1
13			* @version 0.0.1
14			* @license http://www.opensource.org/licenses/mit-license.php MIT License
15			*/
16			namespace Potatobase\Migrations;
17
18			use Migrations\AbstractMigration as BaseAbstractMigration;
19			use Potatobase\DB\Table;
20
21			/**
22			* Class AbstractMigration
23			*
24			* This class is an extension to the CakePHP AbstractMigration class that allows us to specify our own Table Class so
25			* that we can use the new functionality that we have added.
26			*
27			* @package Potatobase\Migrations
28			*/
29			class AbstractMigration extends BaseAbstractMigration
30			{
31			/**
32			* Returns an instance of the <code>\Table</code> class.
33			*
34			* You can use this class to create and manipulate tables.
35			*
36			* @param string $tableName Table Name
37			* @param array $options Options
38			* @return Table
39			*/
40			public function table($tableName, $options = [])
41			{
42			return new Table($tableName, $options, $this->getAdapter());
			0 ignored issues – show Bug Best Practice introduced 2016-07-25 05:01 UTC by Report Bug Copy Issue Report The return type of `return new \Potatobase\D..., $this->getAdapter());` (`Potatobase\DB\Table`) is incompatible with the return type of the parent method `Migrations\AbstractMigration::table` of type `Migrations\Table`. 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...
43			}
44			}
45

PotatoPowered / potatobase

Branch — development (ef4cc3)

AbstractMigration::table() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like