SRFHash::getParamDefinitions()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 8

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 8
ccs 0
cts 6
cp 0
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
crap 2
1
<?php
2
3
use MediaWiki\MediaWikiServices;
4
5
/**
6
 * Query format for arrays with features for Extensions 'Arrays' and 'HashTables'
7
 *
8
 * @file
9
 * @ingroup SemanticResultFormats
10
 * @author Daniel Werner < [email protected] >
11
 *
12
 * Doesn't require 'Arrays' nor 'HashTables' exytensions but has additional features
13
 * ('name' parameter in either result format) if they are available.
14
 *
15
 * Arrays 2.0+ and HashTables 1.0+ are recommended but not necessary.
16
 */
17
class SRFHash extends SRFArray {
18
19
	protected $mLastPageTitle;
20
21
	protected function deliverPageTitle( $value, $link = false ) {
22
		$this->mLastPageTitle = $this->deliverSingleValue( $value, $link ); //remember the page title
23
		return null; //don't add page title into property list
24
	}
25
26
	protected function deliverPageProperties( $perProperty_items ) {
27
		if ( count( $perProperty_items ) < 1 ) {
28
			return null;
29
		}
30
		return [ $this->mLastPageTitle, implode( $this->mPropSep, $perProperty_items ) ];
0 ignored issues
show
Bug Best Practice introduced by jeroendedauw
The return type of return array($this->mLas..., $perProperty_items)); (string[]) is incompatible with the return type of the parent method SRFArray::deliverPageProperties of type null|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...
31
	}
32
33
	protected function deliverQueryResultPages( $perPage_items ) {
34
		$hash = [];
35
		foreach ( $perPage_items as $page ) {
36
			$hash[$page[0]] = $page[1];  //name of page as key, Properties as value
37
		}
38
		return parent::deliverQueryResultPages( $hash );
39
	}
40
41
	protected function createArray( $hash ) {
42
		global $wgHashTables;
43
44
		$hashId = $this->mArrayName;
45
		$version = null;
46
		if ( defined( 'ExtHashTables::VERSION' ) ) {
47
			$version = ExtHashTables::VERSION;
48
		}
49
		if ( $version !== null && version_compare( $version, '0.999', '>=' ) ) {
50
			// Version 1.0+, doesn't use $wgHashTables anymore
51
			/** ToDo: is there a way to get the actual parser which has started the query? */
52
			$parser = MediaWikiServices::getInstance()->getParser();
53
			ExtHashTables::get( $parser )->createHash( $hashId, $hash );
54
		} elseif ( !isset( $wgHashTables ) ) {
55
			// Hash extension is not installed in this wiki
56
			return false;
57
		} elseif ( $version !== null && version_compare( $version, '0.6', '>=' ) ) {
58
			// HashTables 0.6 to 1.0
59
			$wgHashTables->createHash( $hashId, $hash );
60
		} else {
61
			// old HashTables, dirty way
62
			$wgHashTables->mHashTables[trim( $hashId )] = $hash;
63
		}
64
		return true;
65
	}
66
67
	protected function handleParameters( array $params, $outputmode ) {
68
		parent::handleParameters( $params, $outputmode );
69
		$this->mShowPageTitles = true;
70
	}
71
72
	/**
73
	 * @see SMWResultPrinter::getParamDefinitions
74
	 *
75
	 * @since 1.8
76
	 *
77
	 * @param IParamDefinition[] $definitions
78
	 *
79
	 * @return array of IParamDefinition|array
80
	 */
81
	public function getParamDefinitions( array $definitions ) {
82
		$params = parent::getParamDefinitions( $definitions );
83
84
		unset( $params['pagetitle'] ); // page title is Hash key, otherwise, just use Array format!
85
		$params['name']['message'] = 'srf_paramdesc_hashname';
86
87
		return $params;
88
	}
89
90
}
91