RevisionGetter::newRevisionFromResult() - Code Metrics - addwiki/wikibase-api - Measure and Improve Code Quality continuously with Scrutinizer

RevisionGetter::newRevisionFromResult() A
last analyzed 2021-02-03 19:36 UTC

↳ Parent: RevisionGetter

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	2.003

Importance

Changes

Metric	Value
dl	0
loc	13
rs	9.8333
c	0
b	0
f	0
ccs	10
cts	11
cp	0.9091
cc	2
nc	2
nop	1
crap	2.003

<?php

namespace Wikibase\Api\Service;

use Deserializers\Deserializer;
use Mediawiki\Api\MediawikiApi;
use Mediawiki\Api\SimpleRequest;
use Mediawiki\DataModel\PageIdentifier;
use Mediawiki\DataModel\Revision;
use RuntimeException;
use Wikibase\DataModel\Entity\EntityId;
use Wikibase\DataModel\Entity\Item;
use Wikibase\DataModel\Entity\Property;
use Wikibase\DataModel\ItemContent;
use Wikibase\DataModel\PropertyContent;
use Wikibase\DataModel\SiteLink;

/**
 * @access private
 *
 * @author Addshore
 */
class RevisionGetter {

	/**
	 * @var MediawikiApi
	 */
	protected $api;

	/**
	 * @var Deserializer
	 */
	protected $entityDeserializer;

	/**
	 * @param MediawikiApi $api
	 * @param Deserializer $entityDeserializer
	 */
	public function __construct( MediawikiApi $api, Deserializer $entityDeserializer ) {
		$this->api = $api;
		$this->entityDeserializer = $entityDeserializer;
	}

	/**
	 * @since 0.1
	 * @param string|EntityId $id
	 * @return Revision
	 */
	public function getFromId( $id ) {
		if ( $id instanceof EntityId ) {
			$id = $id->getSerialization();
		}

		$result = $this->api->getRequest( new SimpleRequest( 'wbgetentities', [ 'ids' => $id ] ) );
		return $this->newRevisionFromResult( array_shift( $result['entities'] ) );
	}

	/**
	 * @since 0.1
	 * @param SiteLink $siteLink
	 * @return Revision
	 */
	public function getFromSiteLink( SiteLink $siteLink ) {
		$result = $this->api->getRequest( new SimpleRequest(
			'wbgetentities',
			[ 'sites' => $siteLink->getSiteId(), 'titles' => $siteLink->getPageName() ]
		) );
		return $this->newRevisionFromResult( array_shift( $result['entities'] ) );
	}

	/**
	 * @since 0.1
	 * @param string $siteId
	 * @param string $title
	 * @return Revision
	 */
	public function getFromSiteAndTitle( $siteId, $title ) {
		$result = $this->api->getRequest( new SimpleRequest(
			'wbgetentities',
			[ 'sites' => $siteId, 'titles' => $title ]
		) );
		return $this->newRevisionFromResult( array_shift( $result['entities'] ) );
	}

	/**
	 * @param array $entityResult
	 * @return Revision
	 * @todo this could be factored into a different class?
	 */
	private function newRevisionFromResult( array $entityResult ) {
		if ( array_key_exists( 'missing', $entityResult ) ) {
			return false; // Throw an exception?
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());
}
		}
		return new Revision(
			$this->getContentFromEntity( $this->entityDeserializer->deserialize( $entityResult ) ),
			new PageIdentifier( null, intval( $entityResult['pageid'] ) ),
			$entityResult['lastrevid'],
			null,
			null,
			$entityResult['modified']
		);
	}

	/**
	 * @param Item|Property $entity
	 *
	 * @throws RuntimeException
	 * @return ItemContent|PropertyContent
	 * @todo this could be factored into a different class?
	 */
	private function getContentFromEntity( $entity ) {

		switch ( $entity->getType() ) {
			case Item::ENTITY_TYPE:
				return new ItemContent( $entity );

			case Property::ENTITY_TYPE:
				return new PropertyContent( $entity );

			default:
				throw new RuntimeException( 'I cant get a content for this type of entity' );
		}
	}

}


1			<?php
2
3			namespace Wikibase\Api\Service;
4
5			use Deserializers\Deserializer;
6			use Mediawiki\Api\MediawikiApi;
7			use Mediawiki\Api\SimpleRequest;
8			use Mediawiki\DataModel\PageIdentifier;
9			use Mediawiki\DataModel\Revision;
10			use RuntimeException;
11			use Wikibase\DataModel\Entity\EntityId;
12			use Wikibase\DataModel\Entity\Item;
13			use Wikibase\DataModel\Entity\Property;
14			use Wikibase\DataModel\ItemContent;
15			use Wikibase\DataModel\PropertyContent;
16			use Wikibase\DataModel\SiteLink;
17
18			/**
19			* @access private
20			*
21			* @author Addshore
22			*/
23			class RevisionGetter {
24
25			/**
26			* @var MediawikiApi
27			*/
28			protected $api;
29
30			/**
31			* @var Deserializer
32			*/
33			protected $entityDeserializer;
34
35			/**
36			* @param MediawikiApi $api
37			* @param Deserializer $entityDeserializer
38			*/
39	3		public function __construct( MediawikiApi $api, Deserializer $entityDeserializer ) {
40	3		$this->api = $api;
41	3		$this->entityDeserializer = $entityDeserializer;
42	3		}
43
44			/**
45			* @since 0.1
46			* @param string\|EntityId $id
47			* @return Revision
48			*/
49	2		public function getFromId( $id ) {
50	2		if ( $id instanceof EntityId ) {
51	2		$id = $id->getSerialization();
52	1		}
53
54	2		$result = $this->api->getRequest( new SimpleRequest( 'wbgetentities', [ 'ids' => $id ] ) );
55	2		return $this->newRevisionFromResult( array_shift( $result['entities'] ) );
56			}
57
58			/**
59			* @since 0.1
60			* @param SiteLink $siteLink
61			* @return Revision
62			*/
63			public function getFromSiteLink( SiteLink $siteLink ) {
64			$result = $this->api->getRequest( new SimpleRequest(
65			'wbgetentities',
66			[ 'sites' => $siteLink->getSiteId(), 'titles' => $siteLink->getPageName() ]
67			) );
68			return $this->newRevisionFromResult( array_shift( $result['entities'] ) );
69			}
70
71			/**
72			* @since 0.1
73			* @param string $siteId
74			* @param string $title
75			* @return Revision
76			*/
77			public function getFromSiteAndTitle( $siteId, $title ) {
78			$result = $this->api->getRequest( new SimpleRequest(
79			'wbgetentities',
80			[ 'sites' => $siteId, 'titles' => $title ]
81			) );
82			return $this->newRevisionFromResult( array_shift( $result['entities'] ) );
83			}
84
85			/**
86			* @param array $entityResult
87			* @return Revision
88			* @todo this could be factored into a different class?
89			*/
90	2		private function newRevisionFromResult( array $entityResult ) {
91	2		if ( array_key_exists( 'missing', $entityResult ) ) {
92			return false; // Throw an exception?
			0 ignored issues – show Bug Best Practice introduced 2021-01-26 19:25 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `Wikibase\Api\Service\Rev...::newRevisionFromResult` of type `Mediawiki\DataModel\Revision`. 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...
93			}
94	2		return new Revision(
95	2		$this->getContentFromEntity( $this->entityDeserializer->deserialize( $entityResult ) ),
96	2		new PageIdentifier( null, intval( $entityResult['pageid'] ) ),
97	2		$entityResult['lastrevid'],
98	2		null,
99	2		null,
100	2		$entityResult['modified']
101	2		);
102			}
103
104			/**
105			* @param Item\|Property $entity
106			*
107			* @throws RuntimeException
108			* @return ItemContent\|PropertyContent
109			* @todo this could be factored into a different class?
110			*/
111	2	View Code Duplication	private function getContentFromEntity( $entity ) {
			0 ignored issues – show Duplication introduced 2021-01-24 16:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
112	2		switch ( $entity->getType() ) {
113	2		case Item::ENTITY_TYPE:
114	2		return new ItemContent( $entity );
			0 ignored issues – show Bug introduced 2016-02-10 10:30 UTC by Report Bug Copy Issue Report It seems like `$entity` defined by parameter `$entity` on line 111 can also be of type `object<Wikibase\DataModel\Entity\Property>`; however, `Wikibase\DataModel\ItemContent::__construct()` does only seem to accept `object<Wikibase\DataModel\Entity\Item>`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
115			case Property::ENTITY_TYPE:
116			return new PropertyContent( $entity );
			0 ignored issues – show Bug introduced 2016-02-10 10:30 UTC by Report Bug Copy Issue Report It seems like `$entity` defined by parameter `$entity` on line 111 can also be of type `object<Wikibase\DataModel\Entity\Item>`; however, `Wikibase\DataModel\PropertyContent::__construct()` does only seem to accept `object<Wikibase\DataModel\Entity\Property>`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
117			default:
118			throw new RuntimeException( 'I cant get a content for this type of entity' );
119			}
120			}
121
122			}
123

addwiki / wikibase-api

RevisionGetter::newRevisionFromResult() A last analyzed 2021-02-03 19:36 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

RevisionGetter::newRevisionFromResult() A
last analyzed 2021-02-03 19:36 UTC