DescriptionMatchFinder::addFieldsToSelect() - Code Metrics - wmde/WikibaseQueryEngine - Measure and Improve Code Quality continuously with Scrutinizer

DescriptionMatchFinder::addFieldsToSelect() A
last analyzed 2018-05-10 18:41 UTC

↳ Parent: DescriptionMatchFinder

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	3

<?php

namespace Wikibase\QueryEngine\SQLStore\Engine;

use Ask\Language\Description\Description;
use Ask\Language\Description\SomeProperty;
use Ask\Language\Description\ValueDescription;
use Ask\Language\Option\QueryOptions;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\DBALException;
use Doctrine\DBAL\Query\QueryBuilder;
use InvalidArgumentException;
use Iterator;
use Wikibase\DataModel\Entity\EntityId;
use Wikibase\DataModel\Entity\EntityIdParser;
use Wikibase\DataModel\Entity\EntityIdParsingException;
use Wikibase\DataModel\Entity\EntityIdValue;
use Wikibase\DataModel\Entity\PropertyId;
use Wikibase\QueryEngine\PropertyDataValueTypeLookup;
use Wikibase\QueryEngine\QueryEngineException;
use Wikibase\QueryEngine\QueryNotSupportedException;
use Wikibase\QueryEngine\SQLStore\DataValueHandler;
use Wikibase\QueryEngine\SQLStore\StoreSchema;

/**
 * Simple query engine that works on top of the SQLStore.
 *
 * @since 0.1
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < [email protected] >
 */
class DescriptionMatchFinder {

	private $connection;
	private $schema;
	private $propertyDataValueTypeLookup;
	private $idParser;

	/**
	 * @var QueryBuilder
	 */
	private $queryBuilder;

	public function __construct(
		Connection $connection,
		StoreSchema $schema,
		PropertyDataValueTypeLookup $propertyDataValueTypeLookup,
		EntityIdParser $idParser
	) {
		$this->connection = $connection;
		$this->schema = $schema;
		$this->propertyDataValueTypeLookup = $propertyDataValueTypeLookup;
		$this->idParser = $idParser;
	}

	/**
	 * Finds all entities that match the selection criteria.
	 * The matching entities are returned as an array of internal entity ids.
	 *
	 * @param Description $description
	 * @param QueryOptions $options
	 *
	 * @return EntityId[]
	 * @throws QueryNotSupportedException
	 */
	public function findMatchingEntities( Description $description, QueryOptions $options ) {
		$this->queryBuilder = new QueryBuilder( $this->connection );

		if ( $description instanceof SomeProperty ) {
			return $this->findMatchingSomeProperty( $description, $options );
		}

		throw new QueryNotSupportedException( $description );
	}

	/**
	 * @param SomeProperty $description
	 * @param QueryOptions $options
	 *
	 * @return EntityId[]
	 * @throws InvalidArgumentException
	 * @throws QueryNotSupportedException
	 */
	private function findMatchingSomeProperty( SomeProperty $description, QueryOptions $options ) {
		$subDescription = $description->getSubDescription();

		if ( !( $subDescription instanceof ValueDescription ) ) {
			throw new QueryNotSupportedException( $description );
		}

		$this->addPropertyAndValueDescription(
			$this->getPropertyIdFrom( $description ),
			$subDescription
		);

		$this->addOptions( $options );

		return $this->getEntityIdsFromResult( $this->getResultFromQueryBuilder() );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	}

	/**
	 * @param SomeProperty $description
	 *
	 * @throws InvalidArgumentException
	 * @return PropertyId
	 */
	private function getPropertyIdFrom( SomeProperty $description ) {
		$propertyId = $description->getPropertyId();

		if ( !( $propertyId instanceof EntityIdValue ) ) {
			throw new InvalidArgumentException( 'All property ids provided to the SQLStore should be EntityIdValue objects' );
		}

		return $propertyId->getEntityId();
	}

	private function addOptions( QueryOptions $options ) {
		$this->queryBuilder->setMaxResults( $options->getLimit() );
		$this->queryBuilder->setFirstResult( $options->getOffset() );
	}

	private function addPropertyAndValueDescription( PropertyId $propertyId, ValueDescription $description ) {
		$dvHandler = $this->getDataValueHandlerFor( $propertyId );

		$this->addFieldsToSelect(
			$this->queryBuilder,
			array( 'subject_id' ),
			$dvHandler
		);

		$this->queryBuilder->andWhere( 'property_id = :property_id' );
		$this->queryBuilder->setParameter( ':property_id', $propertyId->getSerialization() );

		$dvHandler->addMatchConditions( $this->queryBuilder, $description );
	}

	private function getDataValueHandlerFor( PropertyId $propertyId ) {
		$dataTypeId = $this->propertyDataValueTypeLookup->getDataValueTypeForProperty( $propertyId );

		return $this->schema->getDataValueHandlers()->getMainSnakHandler( $dataTypeId );
	}

	private function addFieldsToSelect( QueryBuilder $builder, array $fieldNames, DataValueHandler $dvHandler ) {
		foreach ( $fieldNames as $fieldName ) {
			$builder->select( $fieldName );
		}

		$builder->from( $dvHandler->getTableName() );
	}

	private function getResultFromQueryBuilder() {
		try {
			return $this->queryBuilder->execute();
		}
		catch ( DBALException $ex ) {
			throw new QueryEngineException( $ex->getMessage(), $ex->getCode(), $ex );
		}
	}

	/**
	 * @param Iterator|array[] $resultRows
	 *
	 * @return EntityId[]
	 */
	private function getEntityIdsFromResult( $resultRows ) {
		$entityIds = array();

		foreach ( $resultRows as $resultRow ) {
			try {
				$entityIds[] = $this->idParser->parse( $resultRow['subject_id'] );
			}
			catch ( EntityIdParsingException $ex ) {
				// Reporting invalid IDs would not be helpful at this point, just skip them.
			}
		}

		return $entityIds;
	}

}


1			<?php
2
3			namespace Wikibase\QueryEngine\SQLStore\Engine;
4
5			use Ask\Language\Description\Description;
6			use Ask\Language\Description\SomeProperty;
7			use Ask\Language\Description\ValueDescription;
8			use Ask\Language\Option\QueryOptions;
9			use Doctrine\DBAL\Connection;
10			use Doctrine\DBAL\DBALException;
11			use Doctrine\DBAL\Query\QueryBuilder;
12			use InvalidArgumentException;
13			use Iterator;
14			use Wikibase\DataModel\Entity\EntityId;
15			use Wikibase\DataModel\Entity\EntityIdParser;
16			use Wikibase\DataModel\Entity\EntityIdParsingException;
17			use Wikibase\DataModel\Entity\EntityIdValue;
18			use Wikibase\DataModel\Entity\PropertyId;
19			use Wikibase\QueryEngine\PropertyDataValueTypeLookup;
20			use Wikibase\QueryEngine\QueryEngineException;
21			use Wikibase\QueryEngine\QueryNotSupportedException;
22			use Wikibase\QueryEngine\SQLStore\DataValueHandler;
23			use Wikibase\QueryEngine\SQLStore\StoreSchema;
24
25			/**
26			* Simple query engine that works on top of the SQLStore.
27			*
28			* @since 0.1
29			*
30			* @licence GNU GPL v2+
31			* @author Jeroen De Dauw < [email protected] >
32			*/
33			class DescriptionMatchFinder {
34
35			private $connection;
36			private $schema;
37			private $propertyDataValueTypeLookup;
38			private $idParser;
39
40			/**
41			* @var QueryBuilder
42			*/
43			private $queryBuilder;
44
45			public function __construct(
46			Connection $connection,
47			StoreSchema $schema,
48			PropertyDataValueTypeLookup $propertyDataValueTypeLookup,
49			EntityIdParser $idParser
50			) {
51			$this->connection = $connection;
52			$this->schema = $schema;
53			$this->propertyDataValueTypeLookup = $propertyDataValueTypeLookup;
54			$this->idParser = $idParser;
55			}
56
57			/**
58			* Finds all entities that match the selection criteria.
59			* The matching entities are returned as an array of internal entity ids.
60			*
61			* @param Description $description
62			* @param QueryOptions $options
63			*
64			* @return EntityId[]
65			* @throws QueryNotSupportedException
66			*/
67			public function findMatchingEntities( Description $description, QueryOptions $options ) {
68			$this->queryBuilder = new QueryBuilder( $this->connection );
69
70			if ( $description instanceof SomeProperty ) {
71			return $this->findMatchingSomeProperty( $description, $options );
72			}
73
74			throw new QueryNotSupportedException( $description );
75			}
76
77			/**
78			* @param SomeProperty $description
79			* @param QueryOptions $options
80			*
81			* @return EntityId[]
82			* @throws InvalidArgumentException
83			* @throws QueryNotSupportedException
84			*/
85			private function findMatchingSomeProperty( SomeProperty $description, QueryOptions $options ) {
86			$subDescription = $description->getSubDescription();
87
88			if ( !( $subDescription instanceof ValueDescription ) ) {
89			throw new QueryNotSupportedException( $description );
90			}
91
92			$this->addPropertyAndValueDescription(
93			$this->getPropertyIdFrom( $description ),
94			$subDescription
95			);
96
97			$this->addOptions( $options );
98
99			return $this->getEntityIdsFromResult( $this->getResultFromQueryBuilder() );
			0 ignored issues – show Documentation introduced 2018-05-10 18:41 UTC by Report Bug Copy Issue Report `$this->getResultFromQueryBuilder()` is of type `object<Doctrine\DBAL\Driver\Statement>\|integer`, but the function expects a `object<Iterator>\|array<integer,array>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
100			}
101
102			/**
103			* @param SomeProperty $description
104			*
105			* @throws InvalidArgumentException
106			* @return PropertyId
107			*/
108			private function getPropertyIdFrom( SomeProperty $description ) {
109			$propertyId = $description->getPropertyId();
110
111			if ( !( $propertyId instanceof EntityIdValue ) ) {
112			throw new InvalidArgumentException( 'All property ids provided to the SQLStore should be EntityIdValue objects' );
113			}
114
115			return $propertyId->getEntityId();
116			}
117
118			private function addOptions( QueryOptions $options ) {
119			$this->queryBuilder->setMaxResults( $options->getLimit() );
120			$this->queryBuilder->setFirstResult( $options->getOffset() );
121			}
122
123			private function addPropertyAndValueDescription( PropertyId $propertyId, ValueDescription $description ) {
124			$dvHandler = $this->getDataValueHandlerFor( $propertyId );
125
126			$this->addFieldsToSelect(
127			$this->queryBuilder,
128			array( 'subject_id' ),
129			$dvHandler
130			);
131
132			$this->queryBuilder->andWhere( 'property_id = :property_id' );
133			$this->queryBuilder->setParameter( ':property_id', $propertyId->getSerialization() );
134
135			$dvHandler->addMatchConditions( $this->queryBuilder, $description );
136			}
137
138			private function getDataValueHandlerFor( PropertyId $propertyId ) {
139			$dataTypeId = $this->propertyDataValueTypeLookup->getDataValueTypeForProperty( $propertyId );
140
141			return $this->schema->getDataValueHandlers()->getMainSnakHandler( $dataTypeId );
142			}
143
144			private function addFieldsToSelect( QueryBuilder $builder, array $fieldNames, DataValueHandler $dvHandler ) {
145			foreach ( $fieldNames as $fieldName ) {
146			$builder->select( $fieldName );
147			}
148
149			$builder->from( $dvHandler->getTableName() );
150			}
151
152			private function getResultFromQueryBuilder() {
153			try {
154			return $this->queryBuilder->execute();
155			}
156			catch ( DBALException $ex ) {
157			throw new QueryEngineException( $ex->getMessage(), $ex->getCode(), $ex );
158			}
159			}
160
161			/**
162			* @param Iterator\|array[] $resultRows
163			*
164			* @return EntityId[]
165			*/
166			private function getEntityIdsFromResult( $resultRows ) {
167			$entityIds = array();
168
169			foreach ( $resultRows as $resultRow ) {
170			try {
171			$entityIds[] = $this->idParser->parse( $resultRow['subject_id'] );
172			}
173			catch ( EntityIdParsingException $ex ) {
174			// Reporting invalid IDs would not be helpful at this point, just skip them.
175			}
176			}
177
178			return $entityIds;
179			}
180
181			}
182

wmde / WikibaseQueryEngine

DescriptionMatchFinder::addFieldsToSelect() A last analyzed 2018-05-10 18:41 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

DescriptionMatchFinder::addFieldsToSelect() A
last analyzed 2018-05-10 18:41 UTC