ResourceListForEntityProperty - Code Metrics - ProjetPP/PPP-Wikidata - Measure and Improve Code Quality continuously with Scrutinizer

ResourceListForEntityProperty A
last analyzed 2017-11-28 20:07 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

90.48%

Importance

Changes

Metric	Value
wmc	8
lcom	1
cbo	5
dl	0
loc	51
ccs	19
cts	21
cp	0.9048
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Size	Complexity
A	__construct()	3	1
A	getForEntityProperty()	10	2
A	getSnaksForProperty()	7	2
A	snaksToNodes()	12	3

<?php

namespace PPP\Wikidata\TreeSimplifier;

use PPP\DataModel\ResourceListNode;
use PPP\Wikidata\WikibaseResourceNode;
use Wikibase\DataModel\Entity\EntityDocument;
use Wikibase\DataModel\Entity\EntityId;
use Wikibase\DataModel\Entity\PropertyId;
use Wikibase\DataModel\Snak\PropertyValueSnak;
use Wikibase\DataModel\Statement\StatementListProvider;
use Wikibase\EntityStore\EntityStore;

/**
 * Simplifies a triple node when the object is missing.
 *
 * @licence AGPLv3+
 * @author Thomas Pellissier Tanon
 */
class ResourceListForEntityProperty {

	/**
	 * @var EntityStore
	 */
	private $entityStore;

	/**
	 * @param EntityStore $entityStore
	 */
	public function __construct(EntityStore $entityStore) {
		$this->entityStore = $entityStore;
	}

	/**
	 * @param EntityId $entityId
	 * @param PropertyId $propertyId
	 * @return ResourceListNode
	 */
	public function getForEntityProperty(EntityId $entityId, PropertyId $propertyId) {
		$entity = $this->entityStore->getEntityDocumentLookup()->getEntityDocumentForId($entityId);

		if($entity === null) {
			return array();
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());
}
		}

		$snaks = $this->getSnaksForProperty($entity, $propertyId);
		return new ResourceListNode($this->snaksToNodes($snaks, $entityId, $propertyId));
	}

	private function getSnaksForProperty(EntityDocument $entity, PropertyId $propertyId) {
		if(!$entity instanceof StatementListProvider) {
			return array();
		}

		return $entity->getStatements()->getByPropertyId($propertyId)->getBestStatements()->getMainSnaks();
	}

	private function snaksToNodes(array $snaks, EntityId $fromSubject, PropertyId $fromProperty) {
		$nodes = array();

		foreach($snaks as $snak) {
			if($snak instanceof PropertyValueSnak) {
				$nodes[] = new WikibaseResourceNode('', $snak->getDataValue(), $fromSubject, $fromProperty);
			}
			//TODO case of PropertySomeValueSnak (MissingNode) and PropertyNoValueSnak (return the negation of the triple?)
		}

		return $nodes;
	}
}


1		<?php
2
3		namespace PPP\Wikidata\TreeSimplifier;
4
5		use PPP\DataModel\ResourceListNode;
6		use PPP\Wikidata\WikibaseResourceNode;
7		use Wikibase\DataModel\Entity\EntityDocument;
8		use Wikibase\DataModel\Entity\EntityId;
9		use Wikibase\DataModel\Entity\PropertyId;
10		use Wikibase\DataModel\Snak\PropertyValueSnak;
11		use Wikibase\DataModel\Statement\StatementListProvider;
12		use Wikibase\EntityStore\EntityStore;
13
14		/**
15		* Simplifies a triple node when the object is missing.
16		*
17		* @licence AGPLv3+
18		* @author Thomas Pellissier Tanon
19		*/
20		class ResourceListForEntityProperty {
21
22		/**
23		* @var EntityStore
24		*/
25		private $entityStore;
26
27		/**
28		* @param EntityStore $entityStore
29		*/
30	4	public function __construct(EntityStore $entityStore) {
31	4	$this->entityStore = $entityStore;
32	4	}
33
34		/**
35		* @param EntityId $entityId
36		* @param PropertyId $propertyId
37		* @return ResourceListNode
38		*/
39	4	public function getForEntityProperty(EntityId $entityId, PropertyId $propertyId) {
40	4	$entity = $this->entityStore->getEntityDocumentLookup()->getEntityDocumentForId($entityId);
41
42	4	if($entity === null) {
43		return array();
		0 ignored issues – show Bug Best Practice introduced 2016-01-11 15:51 UTC by Report Bug Copy Issue Report The return type of `return array();` (`array`) is incompatible with the return type documented by `PPP\Wikidata\TreeSimplif...y::getForEntityProperty` of type `PPP\DataModel\ResourceListNode`. 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...
44		}
45
46	4	$snaks = $this->getSnaksForProperty($entity, $propertyId);
47	4	return new ResourceListNode($this->snaksToNodes($snaks, $entityId, $propertyId));
48		}
49
50	4	private function getSnaksForProperty(EntityDocument $entity, PropertyId $propertyId) {
51	4	if(!$entity instanceof StatementListProvider) {
52		return array();
53		}
54
55	4	return $entity->getStatements()->getByPropertyId($propertyId)->getBestStatements()->getMainSnaks();
56		}
57
58	4	private function snaksToNodes(array $snaks, EntityId $fromSubject, PropertyId $fromProperty) {
59	4	$nodes = array();
60
61	4	foreach($snaks as $snak) {
62	3	if($snak instanceof PropertyValueSnak) {
63	2	$nodes[] = new WikibaseResourceNode('', $snak->getDataValue(), $fromSubject, $fromProperty);
64	2	}
65		//TODO case of PropertySomeValueSnak (MissingNode) and PropertyNoValueSnak (return the negation of the triple?)
66	4	}
67
68	4	return $nodes;
69		}
70		}
71

ProjetPP / PPP-Wikidata

ResourceListForEntityProperty A last analyzed 2017-11-28 20:07 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Duplication Side-by-Side

Filter issues like

ResourceListForEntityProperty A
last analyzed 2017-11-28 20:07 UTC