TruthyStatementRdfBuilder::addMainSnak() - Code Metrics - wikimedia/mediawiki-extensions-Wikibase - Measure and Improve Code Quality continuously with Scrutinizer

TruthyStatementRdfBuilder::addMainSnak() A
last analyzed 2020-11-13 17:34 UTC

↳ Parent: TruthyStatementRdfBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	9.6333
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php

namespace Wikibase\Repo\Rdf;

use InvalidArgumentException;
use Wikibase\DataModel\Entity\EntityDocument;
use Wikibase\DataModel\Entity\EntityId;
use Wikibase\DataModel\Statement\Statement;
use Wikibase\DataModel\Statement\StatementList;
use Wikibase\DataModel\Statement\StatementListProvider;
use Wikimedia\Purtle\RdfWriter;

/**
 * "Truthy" RDF mapping for wikibase statements, directly mapping properties to "best" values
 * without modelling statements as identifiable objects. "Best" statements per property are
 * statements that have the best non-deprecated rank.
 *
 * This simple property to value mapping excludes deprecated and non-"best" statements, ranks,
 * qualifiers, and references. This allows for a much simpler, much easier to query RDF structure
 * that allows searching for values similar to what would have been shown in infoboxes via Lua.
 *
 * If more information is needed, use FullStatementRdfBuilder instead.
 *
 * @see FullStatementRdfBuilder
 *
 * @license GPL-2.0-or-later
 * @author Daniel Kinzler
 * @author Stas Malyshev
 */
class TruthyStatementRdfBuilder implements EntityRdfBuilder {

	/**
	 * @var RdfVocabulary
	 */
	private $vocabulary;

	/**
	 * @var RdfWriter
	 */
	private $writer;

	/**
	 * @var SnakRdfBuilder
	 */
	private $snakBuilder;

	public function __construct( RdfVocabulary $vocabulary, RdfWriter $writer, SnakRdfBuilder $snakBuilder ) {
		$this->vocabulary = $vocabulary;
		$this->writer = $writer;
		$this->snakBuilder = $snakBuilder;
	}

	/**
	 * Adds Statements to the RDF graph.
	 *
	 * @param EntityId $entityId
	 * @param StatementList $statementList
	 */
	public function addStatements( EntityId $entityId, StatementList $statementList ) {
		// FIXME: getBestStatementPerProperty() uis expensive, share the result with FullStatementRdfBuilder!
		foreach ( $statementList->getPropertyIds() as $propertyId ) {
			foreach ( $statementList->getByPropertyId( $propertyId )->getBestStatements() as $statement ) {
				$this->addMainSnak( $entityId, $statement );
			}
		}
	}

	/**
	 * Adds the given Statement's main Snak to the RDF graph.
	 *
	 * @todo share more of this code with FullStatementRdfBuilder
	 *
	 * @param EntityId $entityId
	 * @param Statement $statement
	 *
	 * @throws InvalidArgumentException
	 */
	private function addMainSnak( EntityId $entityId, Statement $statement ) {
		$snak = $statement->getMainSnak();

		$entityLName = $this->vocabulary->getEntityLName( $entityId );
		$entityRepoName = $this->vocabulary->getEntityRepositoryName( $entityId );

		$snakNamespace = $this->vocabulary->statementNamespaceNames[$entityRepoName][RdfVocabulary::NS_VALUE];

		$this->writer->about( $this->vocabulary->entityNamespaceNames[$entityRepoName], $entityLName );

		$propertyRepoName = $this->vocabulary->getEntityRepositoryName( $snak->getPropertyId() );
		$this->snakBuilder->addSnak(
			$this->writer,
			$snakNamespace,
			$snak,
			$this->vocabulary->propertyNamespaceNames[$propertyRepoName][RdfVocabulary::NSP_DIRECT_CLAIM],
			$this->vocabulary->getStatementLName( $statement )
		);
	}

	/**
	 * Add truthy statements for the given entity to the RDF graph.
	 *
	 * @param EntityDocument $entity the entity to output.
	 */
	public function addEntity( EntityDocument $entity ) {
		$entityId = $entity->getId();

		if ( $entity instanceof StatementListProvider ) {
			$this->addStatements( $entityId, $entity->getStatements() );
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
		}
	}

	/**
	 * Does nothing, since Statements should not be part of entity stubs.
	 *
	 * @see EntityRdfBuilder::addEntityStub
	 *
	 * @param EntityDocument $entity the entity to output.
	 */
	public function addEntityStub( EntityDocument $entity ) {
		// noop
	}

}


1			<?php
2
3			namespace Wikibase\Repo\Rdf;
4
5			use InvalidArgumentException;
6			use Wikibase\DataModel\Entity\EntityDocument;
7			use Wikibase\DataModel\Entity\EntityId;
8			use Wikibase\DataModel\Statement\Statement;
9			use Wikibase\DataModel\Statement\StatementList;
10			use Wikibase\DataModel\Statement\StatementListProvider;
11			use Wikimedia\Purtle\RdfWriter;
12
13			/**
14			* "Truthy" RDF mapping for wikibase statements, directly mapping properties to "best" values
15			* without modelling statements as identifiable objects. "Best" statements per property are
16			* statements that have the best non-deprecated rank.
17			*
18			* This simple property to value mapping excludes deprecated and non-"best" statements, ranks,
19			* qualifiers, and references. This allows for a much simpler, much easier to query RDF structure
20			* that allows searching for values similar to what would have been shown in infoboxes via Lua.
21			*
22			* If more information is needed, use FullStatementRdfBuilder instead.
23			*
24			* @see FullStatementRdfBuilder
25			*
26			* @license GPL-2.0-or-later
27			* @author Daniel Kinzler
28			* @author Stas Malyshev
29			*/
30			class TruthyStatementRdfBuilder implements EntityRdfBuilder {
31
32			/**
33			* @var RdfVocabulary
34			*/
35			private $vocabulary;
36
37			/**
38			* @var RdfWriter
39			*/
40			private $writer;
41
42			/**
43			* @var SnakRdfBuilder
44			*/
45			private $snakBuilder;
46
47			public function __construct( RdfVocabulary $vocabulary, RdfWriter $writer, SnakRdfBuilder $snakBuilder ) {
48			$this->vocabulary = $vocabulary;
49			$this->writer = $writer;
50			$this->snakBuilder = $snakBuilder;
51			}
52
53			/**
54			* Adds Statements to the RDF graph.
55			*
56			* @param EntityId $entityId
57			* @param StatementList $statementList
58			*/
59			public function addStatements( EntityId $entityId, StatementList $statementList ) {
60			// FIXME: getBestStatementPerProperty() uis expensive, share the result with FullStatementRdfBuilder!
61			foreach ( $statementList->getPropertyIds() as $propertyId ) {
62			foreach ( $statementList->getByPropertyId( $propertyId )->getBestStatements() as $statement ) {
63			$this->addMainSnak( $entityId, $statement );
64			}
65			}
66			}
67
68			/**
69			* Adds the given Statement's main Snak to the RDF graph.
70			*
71			* @todo share more of this code with FullStatementRdfBuilder
72			*
73			* @param EntityId $entityId
74			* @param Statement $statement
75			*
76			* @throws InvalidArgumentException
77			*/
78			private function addMainSnak( EntityId $entityId, Statement $statement ) {
79			$snak = $statement->getMainSnak();
80
81			$entityLName = $this->vocabulary->getEntityLName( $entityId );
82			$entityRepoName = $this->vocabulary->getEntityRepositoryName( $entityId );
83
84			$snakNamespace = $this->vocabulary->statementNamespaceNames[$entityRepoName][RdfVocabulary::NS_VALUE];
85
86			$this->writer->about( $this->vocabulary->entityNamespaceNames[$entityRepoName], $entityLName );
87
88			$propertyRepoName = $this->vocabulary->getEntityRepositoryName( $snak->getPropertyId() );
89			$this->snakBuilder->addSnak(
90			$this->writer,
91			$snakNamespace,
92			$snak,
93			$this->vocabulary->propertyNamespaceNames[$propertyRepoName][RdfVocabulary::NSP_DIRECT_CLAIM],
94			$this->vocabulary->getStatementLName( $statement )
95			);
96			}
97
98			/**
99			* Add truthy statements for the given entity to the RDF graph.
100			*
101			* @param EntityDocument $entity the entity to output.
102			*/
103			public function addEntity( EntityDocument $entity ) {
104			$entityId = $entity->getId();
105
106			if ( $entity instanceof StatementListProvider ) {
107			$this->addStatements( $entityId, $entity->getStatements() );
			0 ignored issues – show Bug introduced 2020-06-11 13:01 UTC by Report Bug Copy Issue Report It seems like `$entityId` defined by `$entity->getId()` on line `104` can be `null`; however, `Wikibase\Repo\Rdf\Truthy...uilder::addStatements()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
108			}
109			}
110
111			/**
112			* Does nothing, since Statements should not be part of entity stubs.
113			*
114			* @see EntityRdfBuilder::addEntityStub
115			*
116			* @param EntityDocument $entity the entity to output.
117			*/
118			public function addEntityStub( EntityDocument $entity ) {
119			// noop
120			}
121
122			}
123

wikimedia / mediawiki-extensions-Wikibase

TruthyStatementRdfBuilder::addMainSnak() A last analyzed 2020-11-13 17:34 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

TruthyStatementRdfBuilder::addMainSnak() A
last analyzed 2020-11-13 17:34 UTC