DataValueDeserializer::newDataValueFrom() - Code Metrics - Inspection of "Localisation updates from https://translatewiki.ne..." - SemanticMediaWiki/SemanticExternalQueryLookup - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c3e068...3f9a02 )

unknown

created 2018-06-25 06:19 UTC

DataValueDeserializer::newDataValueFrom() B

↳ Parent: DataValueDeserializer

Complexity

Conditions	8
Paths	12

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	19
CRAP Score	8

Importance

Changes

Metric	Value
dl	0
loc	24
ccs	19
cts	19
cp	1
rs	8.4444
c	0
b	0
f	0
cc	8
nc	12
nop	2
crap	8

<?php

namespace SEQL;

use SMW\DataValueFactory;
use SMW\DIProperty;
use SMW\DIWikiPage;
use SMWContainerSemanticData as ContainerSemanticData;
use SMWDIContainer as DIContainer;
use SMWDITime as DITime;
use SMWDIBlob as DIBlob;

/**
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class DataValueDeserializer {

	/**
	 * @var string
	 */
	private $querySource;

	/**
	 * @var EmbeddedLinksReplacer
	 */
	private $embeddedLinksReplacer;

	/**
	 * @since 1.0
	 *
	 * @param string $querySource
	 */
	public function __construct( $querySource ) {
		$this->querySource = $querySource;
		$this->embeddedLinksReplacer = new EmbeddedLinksReplacer( $querySource );
	}

	/**
	 * @since 1.0
	 *
	 * @return string
	 */
	public function getQuerySource() {
		return $this->querySource;
	}

	/**
	 * @since 1.0
	 *
	 * @param DIProperty $property
	 * @param array|string $value
	 *
	 * @return DataValue
	 */
	public function newDataValueFrom( DIProperty $property, $value ) {

		$dv = null;
		$propertyList = array();

		if ( $property->findPropertyTypeId() === '_wpg' || isset( $value['fulltext'] ) ) {

			$dv = $this->newDataValueFromDataItem( $property, $this->newDiWikiPage( $value ) );

		} elseif ( strpos( $property->findPropertyTypeId(), '_rec' ) !== false ) {

			$dv = $this->newDataValueFromDataItem( $property, $this->newDiContainerOnRecordType( $value, $propertyList ) );
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			$dv->setFieldProperties( $propertyList );
		} elseif ( $property->findPropertyTypeId() === '_dat' ) {

			$dv = $this->newDataValueFromDataItem( $property, $this->newDiTime( $value ) );

		} elseif ( strpos( $property->findPropertyTypeId(), '_txt' ) !== false ) {

			$dv = $this->newDataValueFromDataItem( $property, $this->newDiBlob( $value ) );
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		} elseif ( $property->findPropertyTypeId() === '_qty' ) {

			$dv = $this->newDataValueFromPropertyObject( $property, $value['value'] . ' ' . $value['unit']  );
		}

		if ( $dv === null ) {
			$dv = $this->newDataValueFromPropertyObject( $property, $value );
		}

		return $dv;
	}

	/**
	 * @since 1.0
	 *
	 * @param array $value
	 *
	 * @return DIWikiPage|false
	 */
	public function newDiWikiPage( array $value ) {

		if ( !isset( $value['namespace'] ) || !isset( $value['fulltext'] ) ) {
			return false;
		}

		$ns = (int)$value['namespace'] === NS_CATEGORY ? NS_CATEGORY : NS_MAIN;

		if ( $ns === NS_CATEGORY ) {
			$value['fulltext'] = substr( $value['fulltext'], ($pos = strpos( $value['fulltext'], ':') ) !== false ? $pos + 1 : 0 );
		}

		$title = \Title::newFromText( $this->querySource . ':' . str_replace(" ", "_", $value['fulltext'] ), $ns );

		return DIWikiPage::newFromTitle( $title );
	}

	private function newDiTime( $value ) {

		if ( isset( $value['raw'] ) ) {
			return DITime::doUnserialize( $value['raw'] );
		}

		// < 0.7 API format
		// Avoid something like "Part of the date is out of bounds" where the API
		// doesn't sent a raw format
		// return 9999 BC to indicate that we hit a bounds with the timespamp
		try{
			$dataItem = DITime::newFromTimestamp( $value );
		} catch ( \Exception $e ) {
			$dataItem = DITime::doUnserialize( '2/-9999' );
		}

		return $dataItem;
	}

	private function newDiBlob( $value ) {
		return new DIBlob( $this->embeddedLinksReplacer->replace( $value ) );
	}

	private function newDataValueFromPropertyObject( $property, $value ) {

		try{
			$dv = DataValueFactory::newPropertyObjectValue( $property, $value );

		} catch ( \Exception $e ) {
			$dv = false;
		}

		return $dv;
	}

	private function newDataValueFromDataItem( $property, $dataItem = false ) {

		if ( $dataItem === false ) {
			return false;
		}

		try{
			$dv = DataValueFactory::newDataItemValue( $dataItem, $property );
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		} catch ( \Exception $e ) {
			$dv = false;
		}

		return $dv;
	}

	private function newDiContainerOnRecordType( array $value, &$propertyList ) {

		// Remote container to use an anonymous
		$semanticData = ContainerSemanticData::makeAnonymousContainer();

		foreach ( $value as $recValue ) {
			$recordProperty = DIProperty::newFromUserLabel( $recValue['label'] );
			$recordProperty->setInterwiki( $this->querySource );
			$recordProperty->setPropertyTypeId( $recValue['typeid'] );

			$propertyList[] = $recordProperty;

			foreach ( $recValue['item'] as $item ) {
				$dataValue = $this->newDataValueFrom( $recordProperty, $item );

				if ( $dataValue === false ) {
					continue;
				}

				$semanticData->addPropertyObjectValue( $recordProperty, $dataValue->getDataItem() );
			}
		}

		return new DIContainer( $semanticData );
	}

}


1		<?php
2
3		namespace SEQL;
4
5		use SMW\DataValueFactory;
6		use SMW\DIProperty;
7		use SMW\DIWikiPage;
8		use SMWContainerSemanticData as ContainerSemanticData;
9		use SMWDIContainer as DIContainer;
10		use SMWDITime as DITime;
11		use SMWDIBlob as DIBlob;
12
13		/**
14		* @license GNU GPL v2+
15		* @since 1.0
16		*
17		* @author mwjames
18		*/
19		class DataValueDeserializer {
20
21		/**
22		* @var string
23		*/
24		private $querySource;
25
26		/**
27		* @var EmbeddedLinksReplacer
28		*/
29		private $embeddedLinksReplacer;
30
31		/**
32		* @since 1.0
33		*
34		* @param string $querySource
35		*/
36	15	public function __construct( $querySource ) {
37	15	$this->querySource = $querySource;
38	15	$this->embeddedLinksReplacer = new EmbeddedLinksReplacer( $querySource );
39	15	}
40
41		/**
42		* @since 1.0
43		*
44		* @return string
45		*/
46	8	public function getQuerySource() {
47	8	return $this->querySource;
48		}
49
50		/**
51		* @since 1.0
52		*
53		* @param DIProperty $property
54		* @param array\|string $value
55		*
56		* @return DataValue
57		*/
58	12	public function newDataValueFrom( DIProperty $property, $value ) {
59
60	12	$dv = null;
61	12	$propertyList = array();
62
63	12	if ( $property->findPropertyTypeId() === '_wpg' \|\| isset( $value['fulltext'] ) ) {
		0 ignored issues – show Deprecated Code introduced 2018-01-09 23:31 UTC by Report Bug Copy Issue Report The method `SMW\DIProperty::findPropertyTypeId()` has been deprecated with message: since 3.0, use DIProperty::findPropertyValueType This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
64	2	$dv = $this->newDataValueFromDataItem( $property, $this->newDiWikiPage( $value ) );
		0 ignored issues – show Bug introduced 2015-12-01 10:33 UTC by Report Bug Copy Issue Report It seems like `$this->newDiWikiPage($value)` targeting `SEQL\DataValueDeserializer::newDiWikiPage()` can also be of type `object<SMW\DIWikiPage>`; however, `SEQL\DataValueDeserializ...DataValueFromDataItem()` does only seem to accept `boolean`, maybe add an additional type check? This check looks at variables that 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... Bug introduced 2016-03-13 02:49 UTC by Report Bug Copy Issue Report It seems like `$value` defined by parameter `$value` on line 58 can also be of type `string`; however, `SEQL\DataValueDeserializer::newDiWikiPage()` does only seem to accept `array`, 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...
65	12	} elseif ( strpos( $property->findPropertyTypeId(), '_rec' ) !== false ) {
		0 ignored issues – show Deprecated Code introduced 2018-01-09 23:31 UTC by Report Bug Copy Issue Report The method `SMW\DIProperty::findPropertyTypeId()` has been deprecated with message: since 3.0, use DIProperty::findPropertyValueType This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
66	2	$dv = $this->newDataValueFromDataItem( $property, $this->newDiContainerOnRecordType( $value, $propertyList ) );
		0 ignored issues – show Documentation introduced 2015-11-24 02:29 UTC by Report Bug Copy Issue Report `$this->newDiContainerOnR...($value, $propertyList)` is of type `object<SMWDIContainer>`, but the function expects a `boolean`. 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... Bug introduced 2016-03-13 02:49 UTC by Report Bug Copy Issue Report It seems like `$value` defined by parameter `$value` on line 58 can also be of type `string`; however, `SEQL\DataValueDeserializ...ContainerOnRecordType()` does only seem to accept `array`, 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...
67	2	$dv->setFieldProperties( $propertyList );
68	11	} elseif ( $property->findPropertyTypeId() === '_dat' ) {
		0 ignored issues – show Deprecated Code introduced 2018-01-09 23:31 UTC by Report Bug Copy Issue Report The method `SMW\DIProperty::findPropertyTypeId()` has been deprecated with message: since 3.0, use DIProperty::findPropertyValueType This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
69	4	$dv = $this->newDataValueFromDataItem( $property, $this->newDiTime( $value ) );
		0 ignored issues – show Bug introduced 2015-11-24 02:29 UTC by Report Bug Copy Issue Report It seems like `$this->newDiTime($value)` targeting `SEQL\DataValueDeserializer::newDiTime()` can also be of type `object<SMWDITime>`; however, `SEQL\DataValueDeserializ...DataValueFromDataItem()` does only seem to accept `boolean`, maybe add an additional type check? This check looks at variables that 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...
70	10	} elseif ( strpos( $property->findPropertyTypeId(), '_txt' ) !== false ) {
		0 ignored issues – show Deprecated Code introduced 2018-01-09 23:31 UTC by Report Bug Copy Issue Report The method `SMW\DIProperty::findPropertyTypeId()` has been deprecated with message: since 3.0, use DIProperty::findPropertyValueType This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
71	2	$dv = $this->newDataValueFromDataItem( $property, $this->newDiBlob( $value ) );
		0 ignored issues – show Documentation introduced 2016-01-04 02:09 UTC by Report Bug Copy Issue Report `$this->newDiBlob($value)` is of type `object<SMWDIBlob>`, but the function expects a `boolean`. 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...
72	6	} elseif ( $property->findPropertyTypeId() === '_qty' ) {
		0 ignored issues – show Deprecated Code introduced 2018-01-09 23:31 UTC by Report Bug Copy Issue Report The method `SMW\DIProperty::findPropertyTypeId()` has been deprecated with message: since 3.0, use DIProperty::findPropertyValueType This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
73	1	$dv = $this->newDataValueFromPropertyObject( $property, $value['value'] . ' ' . $value['unit'] );
74	1	}
75
76	12	if ( $dv === null ) {
77	3	$dv = $this->newDataValueFromPropertyObject( $property, $value );
78	3	}
79
80	12	return $dv;
81		}
82
83		/**
84		* @since 1.0
85		*
86		* @param array $value
87		*
88		* @return DIWikiPage\|false
89		*/
90	11	public function newDiWikiPage( array $value ) {
91
92	11	if ( !isset( $value['namespace'] ) \|\| !isset( $value['fulltext'] ) ) {
93	1	return false;
94		}
95
96	10	$ns = (int)$value['namespace'] === NS_CATEGORY ? NS_CATEGORY : NS_MAIN;
97
98	10	if ( $ns === NS_CATEGORY ) {
99	1	$value['fulltext'] = substr( $value['fulltext'], ($pos = strpos( $value['fulltext'], ':') ) !== false ? $pos + 1 : 0 );
100	1	}
101
102	10	$title = \Title::newFromText( $this->querySource . ':' . str_replace(" ", "_", $value['fulltext'] ), $ns );
103
104	10	return DIWikiPage::newFromTitle( $title );
105		}
106
107	4	private function newDiTime( $value ) {
108
109	4	if ( isset( $value['raw'] ) ) {
110	3	return DITime::doUnserialize( $value['raw'] );
111		}
112
113		// < 0.7 API format
114		// Avoid something like "Part of the date is out of bounds" where the API
115		// doesn't sent a raw format
116		// return 9999 BC to indicate that we hit a bounds with the timespamp
117		try{
118	1	$dataItem = DITime::newFromTimestamp( $value );
119	1	} catch ( \Exception $e ) {
120		$dataItem = DITime::doUnserialize( '2/-9999' );
121		}
122
123	1	return $dataItem;
124		}
125
126	2	private function newDiBlob( $value ) {
127	2	return new DIBlob( $this->embeddedLinksReplacer->replace( $value ) );
128		}
129
130	4	private function newDataValueFromPropertyObject( $property, $value ) {
131
132		try{
133	4	$dv = DataValueFactory::newPropertyObjectValue( $property, $value );
		0 ignored issues – show Deprecated Code introduced 2016-06-22 04:24 UTC by Report Bug Copy Issue Report The method `SMW\DataValueFactory::newPropertyObjectValue()` has been deprecated with message: since 2.4, use DataValueFactory::newDataValueByProperty This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
134	4	} catch ( \Exception $e ) {
135		$dv = false;
136		}
137
138	4	return $dv;
139		}
140
141	8	private function newDataValueFromDataItem( $property, $dataItem = false ) {
142
143	8	if ( $dataItem === false ) {
144	1	return false;
145		}
146
147		try{
148	7	$dv = DataValueFactory::newDataItemValue( $dataItem, $property );
		0 ignored issues – show Documentation introduced 2015-11-24 02:29 UTC by Report Bug Copy Issue Report `$dataItem` is of type `boolean`, but the function expects a `object<SMWDataItem>`. 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... Deprecated Code introduced 2016-06-22 04:24 UTC by Report Bug Copy Issue Report The method `SMW\DataValueFactory::newDataItemValue()` has been deprecated with message: since 2.4, use DataValueFactory::newDataValueByItem This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
149	7	} catch ( \Exception $e ) {
150		$dv = false;
151		}
152
153	7	return $dv;
154		}
155
156	2	private function newDiContainerOnRecordType( array $value, &$propertyList ) {
157
158		// Remote container to use an anonymous
159	2	$semanticData = ContainerSemanticData::makeAnonymousContainer();
160
161	2	foreach ( $value as $recValue ) {
162	2	$recordProperty = DIProperty::newFromUserLabel( $recValue['label'] );
163	2	$recordProperty->setInterwiki( $this->querySource );
164	2	$recordProperty->setPropertyTypeId( $recValue['typeid'] );
		0 ignored issues – show Deprecated Code introduced 2018-01-09 23:31 UTC by Report Bug Copy Issue Report The method `SMW\DIProperty::setPropertyTypeId()` has been deprecated with message: since 3.0, use DIProperty::setPropertyValueType This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
165	2	$propertyList[] = $recordProperty;
166
167	2	foreach ( $recValue['item'] as $item ) {
168	2	$dataValue = $this->newDataValueFrom( $recordProperty, $item );
169
170	2	if ( $dataValue === false ) {
171		continue;
172		}
173
174	2	$semanticData->addPropertyObjectValue( $recordProperty, $dataValue->getDataItem() );
175	2	}
176	2	}
177
178	2	return new DIContainer( $semanticData );
179		}
180
181		}
182

SemanticMediaWiki / SemanticExternalQueryLookup

Push — master ( c3e068...3f9a02 )

DataValueDeserializer::newDataValueFrom() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like