NullStatementGrouper   A
last analyzed

Complexity

Total Complexity 1

Size/Duplication

Total Lines 13
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 0

Test Coverage

Coverage 100%

Importance

Changes 0
Metric Value
wmc 1
c 0
b 0
f 0
lcom 0
cbo 0
dl 0
loc 13
ccs 2
cts 2
cp 1
rs 10

1 Method

Rating   Name   Duplication   Size   Complexity  
A groupStatements() 0 3 1
1
<?php
2
3
namespace Wikibase\DataModel\Services\Statement\Grouper;
4
5
use Wikibase\DataModel\Statement\StatementList;
6
7
/**
8
 * An unconditional statement grouper that always returns a single group, containing the original,
9
 * unmodified list of statements, and nothing else.
10
 *
11
 * @since 3.2
12
 *
13
 * @license GPL-2.0-or-later
14
 * @author Thiemo Kreuz
15
 */
16
class NullStatementGrouper implements StatementGrouper {
17
18
	/**
19
	 * @param StatementList $statements
20
	 *
21 1
	 * @return StatementList[] An associative array, mapping the default group identifier
22 1
	 *  "statements" to the unmodified StatementList object.
23
	 */
24
	public function groupStatements( StatementList $statements ) {
25
		return [ 'statements' => $statements ];
0 ignored issues
show
Bug Best Practice introduced by
The return type of return array('statements' => $statements); (array<string,Wikibase\Da...tatement\StatementList>) is incompatible with the return type declared by the interface Wikibase\DataModel\Servi...rouper::groupStatements of type Wikibase\DataModel\Statement\StatementList[].

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...
26
	}
27
28
}
29