SerializerFactory::newEntitySerializer() - Code Metrics - Inspection of "Improve documentation of confusing newEntity(De)Se..." - wmde/WikibaseDataModelSerialization - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — deprecations25 ( f844c9...90e697 )

by no

created 2017-09-01 15:50 UTC

SerializerFactory::newEntitySerializer() A

↳ Parent: SerializerFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
ccs	4
cts	4
cp	1
rs	9.4285
cc	1
eloc	4
nc	1
nop	0
crap	1

<?php

namespace Wikibase\DataModel;

use InvalidArgumentException;
use Serializers\DispatchableSerializer;
use Serializers\DispatchingSerializer;
use Serializers\Serializer;
use Wikibase\DataModel\Serializers\AliasGroupListSerializer;
use Wikibase\DataModel\Serializers\AliasGroupSerializer;
use Wikibase\DataModel\Serializers\ItemSerializer;
use Wikibase\DataModel\Serializers\PropertySerializer;
use Wikibase\DataModel\Serializers\ReferenceListSerializer;
use Wikibase\DataModel\Serializers\ReferenceSerializer;
use Wikibase\DataModel\Serializers\SiteLinkSerializer;
use Wikibase\DataModel\Serializers\SnakListSerializer;
use Wikibase\DataModel\Serializers\SnakSerializer;
use Wikibase\DataModel\Serializers\StatementListSerializer;
use Wikibase\DataModel\Serializers\StatementSerializer;
use Wikibase\DataModel\Serializers\TermListSerializer;
use Wikibase\DataModel\Serializers\TermSerializer;
use Wikibase\DataModel\Serializers\TypedSnakSerializer;

/**
 * Factory for constructing Serializer objects that can serialize WikibaseDataModel objects.
 *
 * @since 0.1
 *
 * @license GPL-2.0+
 * @author Thomas Pellissier Tanon
 * @author Bene* < [email protected] >
 * @author Addshore
 */
class SerializerFactory {

	const OPTION_DEFAULT = 0;
	/** @since 1.2.0 */
	const OPTION_OBJECTS_FOR_MAPS = 1;
	/**
	 * @since 1.7.0
	 * @deprecated since 2.5 use OPTION_SERIALIZE_SNAKS_WITHOUT_HASH
	 */
	const OPTION_SERIALIZE_MAIN_SNAKS_WITHOUT_HASH = 2;
	/**
	 * @since 1.7.0
	 * @deprecated since 2.5 use OPTION_SERIALIZE_SNAKS_WITHOUT_HASH
	 */
	const OPTION_SERIALIZE_QUALIFIER_SNAKS_WITHOUT_HASH = 4;
	/**
	 * @since 1.7.0
	 * @deprecated since 2.5 use OPTION_SERIALIZE_SNAKS_WITHOUT_HASH
	 */
	const OPTION_SERIALIZE_REFERENCE_SNAKS_WITHOUT_HASH = 8;
	/**
	 * Omit hashes when serializing snaks.
	 * @since 2.5.0
	 */
	const OPTION_SERIALIZE_SNAKS_WITHOUT_HASH = 14; /* =
		self::OPTION_SERIALIZE_MAIN_SNAKS_WITHOUT_HASH |
		self::OPTION_SERIALIZE_QUALIFIER_SNAKS_WITHOUT_HASH |
		self::OPTION_SERIALIZE_REFERENCE_SNAKS_WITHOUT_HASH; */

	/**
	 * @var int
	 */
	private $options;

	/**
	 * @var Serializer
	 */
	private $dataValueSerializer;

	/**
	 * @param Serializer $dataValueSerializer serializer for DataValue objects
	 * @param int $options set multiple with bitwise or
	 *
	 * @throws InvalidArgumentException
	 */
	public function __construct( Serializer $dataValueSerializer, $options = 0 ) {
		if ( !is_int( $options ) ) {
			throw new InvalidArgumentException( '$options must be an integer' );
		}

		$this->dataValueSerializer = $dataValueSerializer;
		$this->options = $options;
	}

	/**
	 * @return bool
	 */
	private function shouldUseObjectsForMaps() {
		return (bool)( $this->options & self::OPTION_OBJECTS_FOR_MAPS );
	}

	/**
	 * @return bool
	 */
	private function shouldSerializeMainSnaksWithHash() {
		return !(bool)( $this->options & self::OPTION_SERIALIZE_MAIN_SNAKS_WITHOUT_HASH );

	}

	/**
	 * @return bool
	 */
	private function shouldSerializeQualifierSnaksWithHash() {
		return !(bool)( $this->options & self::OPTION_SERIALIZE_QUALIFIER_SNAKS_WITHOUT_HASH );

	}

	/**
	 * @return bool
	 */
	private function shouldSerializeReferenceSnaksWithHash() {
		return !(bool)( $this->options & self::OPTION_SERIALIZE_REFERENCE_SNAKS_WITHOUT_HASH );

	}

	/**
	 * @return DispatchableSerializer A serializer that can only serialize Item and Property
	 *  objects, but no other entity types. In contexts with custom entity types other than items
	 *  and properties this is not what you want. If in doubt, favor a custom
	 *  `DispatchingSerializer` containing the exact entity serializers you need.
	 */
	public function newEntitySerializer() {
		return new DispatchingSerializer( [
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			$this->newItemSerializer(),
			$this->newPropertySerializer()
		] );
	}

	/**
	 * Returns a Serializer that can serialize Item objects.
	 *
	 * @since 2.1
	 *
	 * @return Serializer
	 */
	public function newItemSerializer() {
		return new ItemSerializer(
			$this->newTermListSerializer(),
			$this->newAliasGroupListSerializer(),
			$this->newStatementListSerializer(),
			$this->newSiteLinkSerializer(),
			$this->shouldUseObjectsForMaps()
		);
	}

	/**
	 * Returns a Serializer that can serialize Property objects.
	 *
	 * @since 2.1
	 *
	 * @return Serializer
	 */
	public function newPropertySerializer() {
		return new PropertySerializer(
			$this->newTermListSerializer(),
			$this->newAliasGroupListSerializer(),
			$this->newStatementListSerializer()
		);
	}

	/**
	 * Returns a Serializer that can serialize SiteLink objects.
	 *
	 * @return Serializer
	 */
	public function newSiteLinkSerializer() {
		return new SiteLinkSerializer();
	}

	/**
	 * Returns a Serializer that can serialize StatementList objects.
	 *
	 * @since 1.4
	 *
	 * @return Serializer
	 */
	public function newStatementListSerializer() {
		return new StatementListSerializer(
			$this->newStatementSerializer(),
			$this->shouldUseObjectsForMaps()
		);
	}

	/**
	 * Returns a Serializer that can serialize Statement objects.
	 *
	 * @since 1.4
	 *
	 * @return Serializer
	 */
	public function newStatementSerializer() {
		return new StatementSerializer(
			$this->newSnakSerializer( $this->shouldSerializeMainSnaksWithHash() ),
			$this->newSnakListSerializer( $this->shouldSerializeQualifierSnaksWithHash() ),
			$this->newReferencesSerializer()
		);
	}

	/**
	 * Returns a Serializer that can serialize ReferenceList objects.
	 *
	 * @return Serializer
	 */
	public function newReferencesSerializer() {
		return new ReferenceListSerializer( $this->newReferenceSerializer() );
	}

	/**
	 * Returns a Serializer that can serialize Reference objects.
	 *
	 * @return Serializer
	 */
	public function newReferenceSerializer() {
		return new ReferenceSerializer(
			$this->newSnakListSerializer(
				$this->shouldSerializeReferenceSnaksWithHash()
			)
		);
	}

	/**
	 * Returns a Serializer that can serialize SnakList objects.
	 *
	 * @param bool $serializeSnaksWithHash
	 *
	 * @since 1.4
	 *
	 * @return Serializer
	 */
	public function newSnakListSerializer( $serializeSnaksWithHash = true ) {
		return new SnakListSerializer(
			$this->newSnakSerializer( $serializeSnaksWithHash ),
			$this->shouldUseObjectsForMaps()
		);
	}

	/**
	 * Returns a Serializer that can serialize Snak objects.
	 *
	 * @param bool $serializeWithHash
	 *
	 * @return Serializer
	 */
	public function newSnakSerializer( $serializeWithHash = true ) {
		return new SnakSerializer( $this->dataValueSerializer, $serializeWithHash );
	}

	/**
	 * Returns a Serializer that can serialize TypedSnak objects.
	 *
	 * @param bool $serializeWithHash
	 *
	 * @since 1.3
	 *
	 * @return Serializer
	 */
	public function newTypedSnakSerializer( $serializeWithHash = true ) {
		return new TypedSnakSerializer( $this->newSnakSerializer( $serializeWithHash ) );
	}

	/**
	 * Returns a Serializer that can serialize Term objects.
	 *
	 * @since 1.5
	 *
	 * @return Serializer
	 */
	public function newTermSerializer() {
		return new TermSerializer();
	}

	/**
	 * Returns a Serializer that can serialize TermList objects.
	 *
	 * @since 1.5
	 *
	 * @return Serializer
	 */
	public function newTermListSerializer() {
		return new TermListSerializer( $this->newTermSerializer(), $this->shouldUseObjectsForMaps() );
	}

	/**
	 * Returns a Serializer that can serialize AliasGroup objects.
	 *
	 * @since 1.6
	 *
	 * @return Serializer
	 */
	public function newAliasGroupSerializer() {
		return new AliasGroupSerializer();
	}

	/**
	 * Returns a Serializer that can serialize AliasGroupList objects.
	 *
	 * @since 1.5
	 *
	 * @return Serializer
	 */
	public function newAliasGroupListSerializer() {
		return new AliasGroupListSerializer( $this->newAliasGroupSerializer(), $this->shouldUseObjectsForMaps() );
	}

}


1		<?php
2
3		namespace Wikibase\DataModel;
4
5		use InvalidArgumentException;
6		use Serializers\DispatchableSerializer;
7		use Serializers\DispatchingSerializer;
8		use Serializers\Serializer;
9		use Wikibase\DataModel\Serializers\AliasGroupListSerializer;
10		use Wikibase\DataModel\Serializers\AliasGroupSerializer;
11		use Wikibase\DataModel\Serializers\ItemSerializer;
12		use Wikibase\DataModel\Serializers\PropertySerializer;
13		use Wikibase\DataModel\Serializers\ReferenceListSerializer;
14		use Wikibase\DataModel\Serializers\ReferenceSerializer;
15		use Wikibase\DataModel\Serializers\SiteLinkSerializer;
16		use Wikibase\DataModel\Serializers\SnakListSerializer;
17		use Wikibase\DataModel\Serializers\SnakSerializer;
18		use Wikibase\DataModel\Serializers\StatementListSerializer;
19		use Wikibase\DataModel\Serializers\StatementSerializer;
20		use Wikibase\DataModel\Serializers\TermListSerializer;
21		use Wikibase\DataModel\Serializers\TermSerializer;
22		use Wikibase\DataModel\Serializers\TypedSnakSerializer;
23
24		/**
25		* Factory for constructing Serializer objects that can serialize WikibaseDataModel objects.
26		*
27		* @since 0.1
28		*
29		* @license GPL-2.0+
30		* @author Thomas Pellissier Tanon
31		* @author Bene* < [email protected] >
32		* @author Addshore
33		*/
34		class SerializerFactory {
35
36		const OPTION_DEFAULT = 0;
37		/** @since 1.2.0 */
38		const OPTION_OBJECTS_FOR_MAPS = 1;
39		/**
40		* @since 1.7.0
41		* @deprecated since 2.5 use OPTION_SERIALIZE_SNAKS_WITHOUT_HASH
42		*/
43		const OPTION_SERIALIZE_MAIN_SNAKS_WITHOUT_HASH = 2;
44		/**
45		* @since 1.7.0
46		* @deprecated since 2.5 use OPTION_SERIALIZE_SNAKS_WITHOUT_HASH
47		*/
48		const OPTION_SERIALIZE_QUALIFIER_SNAKS_WITHOUT_HASH = 4;
49		/**
50		* @since 1.7.0
51		* @deprecated since 2.5 use OPTION_SERIALIZE_SNAKS_WITHOUT_HASH
52		*/
53		const OPTION_SERIALIZE_REFERENCE_SNAKS_WITHOUT_HASH = 8;
54		/**
55		* Omit hashes when serializing snaks.
56		* @since 2.5.0
57		*/
58		const OPTION_SERIALIZE_SNAKS_WITHOUT_HASH = 14; /* =
59		self::OPTION_SERIALIZE_MAIN_SNAKS_WITHOUT_HASH \|
60		self::OPTION_SERIALIZE_QUALIFIER_SNAKS_WITHOUT_HASH \|
61		self::OPTION_SERIALIZE_REFERENCE_SNAKS_WITHOUT_HASH; */
62
63		/**
64		* @var int
65		*/
66		private $options;
67
68		/**
69		* @var Serializer
70		*/
71		private $dataValueSerializer;
72
73		/**
74		* @param Serializer $dataValueSerializer serializer for DataValue objects
75		* @param int $options set multiple with bitwise or
76		*
77		* @throws InvalidArgumentException
78		*/
79	52	public function __construct( Serializer $dataValueSerializer, $options = 0 ) {
80	52	if ( !is_int( $options ) ) {
81	1	throw new InvalidArgumentException( '$options must be an integer' );
82		}
83
84	51	$this->dataValueSerializer = $dataValueSerializer;
85	51	$this->options = $options;
86	51	}
87
88		/**
89		* @return bool
90		*/
91	38	private function shouldUseObjectsForMaps() {
92	38	return (bool)( $this->options & self::OPTION_OBJECTS_FOR_MAPS );
93		}
94
95		/**
96		* @return bool
97		*/
98	22	private function shouldSerializeMainSnaksWithHash() {
99	22	return !(bool)( $this->options & self::OPTION_SERIALIZE_MAIN_SNAKS_WITHOUT_HASH );
		0 ignored issues – show Deprecated Code introduced 2017-08-30 13:01 UTC by Report Bug Copy Issue Report The constant `Wikibase\DataModel\Seria...MAIN_SNAKS_WITHOUT_HASH` has been deprecated with message: since 2.5 use OPTION_SERIALIZE_SNAKS_WITHOUT_HASH This class constant 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 constant will be removed from the class and what other constant to use instead. Loading history...
100		}
101
102		/**
103		* @return bool
104		*/
105	22	private function shouldSerializeQualifierSnaksWithHash() {
106	22	return !(bool)( $this->options & self::OPTION_SERIALIZE_QUALIFIER_SNAKS_WITHOUT_HASH );
		0 ignored issues – show Deprecated Code introduced 2017-08-30 13:01 UTC by Report Bug Copy Issue Report The constant `Wikibase\DataModel\Seria...FIER_SNAKS_WITHOUT_HASH` has been deprecated with message: since 2.5 use OPTION_SERIALIZE_SNAKS_WITHOUT_HASH This class constant 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 constant will be removed from the class and what other constant to use instead. Loading history...
107		}
108
109		/**
110		* @return bool
111		*/
112	30	private function shouldSerializeReferenceSnaksWithHash() {
113	30	return !(bool)( $this->options & self::OPTION_SERIALIZE_REFERENCE_SNAKS_WITHOUT_HASH );
		0 ignored issues – show Deprecated Code introduced 2017-08-30 13:01 UTC by Report Bug Copy Issue Report The constant `Wikibase\DataModel\Seria...ENCE_SNAKS_WITHOUT_HASH` has been deprecated with message: since 2.5 use OPTION_SERIALIZE_SNAKS_WITHOUT_HASH This class constant 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 constant will be removed from the class and what other constant to use instead. Loading history...
114		}
115
116		/**
117		* @return DispatchableSerializer A serializer that can only serialize Item and Property
118		* objects, but no other entity types. In contexts with custom entity types other than items
119		* and properties this is not what you want. If in doubt, favor a custom
120		* `DispatchingSerializer` containing the exact entity serializers you need.
121		*/
122	1	public function newEntitySerializer() {
123	1	return new DispatchingSerializer( [
		0 ignored issues – show Documentation introduced 2017-07-28 12:25 UTC by Report Bug Copy Issue Report `array($this->newItemSeri...ewPropertySerializer())` is of type `array<integer,object<Ser...alizers\\Serializer>"}>`, but the function expects a `array<integer,object<Ser...ispatchableSerializer>>`. 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...
124	1	$this->newItemSerializer(),
125	1	$this->newPropertySerializer()
126		] );
127		}
128
129		/**
130		* Returns a Serializer that can serialize Item objects.
131		*
132		* @since 2.1
133		*
134		* @return Serializer
135		*/
136	8	public function newItemSerializer() {
137	8	return new ItemSerializer(
138	8	$this->newTermListSerializer(),
139	8	$this->newAliasGroupListSerializer(),
140	8	$this->newStatementListSerializer(),
141	8	$this->newSiteLinkSerializer(),
142	8	$this->shouldUseObjectsForMaps()
143		);
144		}
145
146		/**
147		* Returns a Serializer that can serialize Property objects.
148		*
149		* @since 2.1
150		*
151		* @return Serializer
152		*/
153	3	public function newPropertySerializer() {
154	3	return new PropertySerializer(
155	3	$this->newTermListSerializer(),
156	3	$this->newAliasGroupListSerializer(),
157	3	$this->newStatementListSerializer()
158		);
159		}
160
161		/**
162		* Returns a Serializer that can serialize SiteLink objects.
163		*
164		* @return Serializer
165		*/
166	12	public function newSiteLinkSerializer() {
167	12	return new SiteLinkSerializer();
168		}
169
170		/**
171		* Returns a Serializer that can serialize StatementList objects.
172		*
173		* @since 1.4
174		*
175		* @return Serializer
176		*/
177	14	public function newStatementListSerializer() {
178	14	return new StatementListSerializer(
179	14	$this->newStatementSerializer(),
180	14	$this->shouldUseObjectsForMaps()
181		);
182		}
183
184		/**
185		* Returns a Serializer that can serialize Statement objects.
186		*
187		* @since 1.4
188		*
189		* @return Serializer
190		*/
191	22	public function newStatementSerializer() {
192	22	return new StatementSerializer(
193	22	$this->newSnakSerializer( $this->shouldSerializeMainSnaksWithHash() ),
194	22	$this->newSnakListSerializer( $this->shouldSerializeQualifierSnaksWithHash() ),
195	22	$this->newReferencesSerializer()
196		);
197		}
198
199		/**
200		* Returns a Serializer that can serialize ReferenceList objects.
201		*
202		* @return Serializer
203		*/
204	26	public function newReferencesSerializer() {
205	26	return new ReferenceListSerializer( $this->newReferenceSerializer() );
206		}
207
208		/**
209		* Returns a Serializer that can serialize Reference objects.
210		*
211		* @return Serializer
212		*/
213	30	public function newReferenceSerializer() {
214	30	return new ReferenceSerializer(
215	30	$this->newSnakListSerializer(
216	30	$this->shouldSerializeReferenceSnaksWithHash()
217		)
218		);
219		}
220
221		/**
222		* Returns a Serializer that can serialize SnakList objects.
223		*
224		* @param bool $serializeSnaksWithHash
225		*
226		* @since 1.4
227		*
228		* @return Serializer
229		*/
230	36	public function newSnakListSerializer( $serializeSnaksWithHash = true ) {
231	36	return new SnakListSerializer(
232	36	$this->newSnakSerializer( $serializeSnaksWithHash ),
233	36	$this->shouldUseObjectsForMaps()
234		);
235		}
236
237		/**
238		* Returns a Serializer that can serialize Snak objects.
239		*
240		* @param bool $serializeWithHash
241		*
242		* @return Serializer
243		*/
244	43	public function newSnakSerializer( $serializeWithHash = true ) {
245	43	return new SnakSerializer( $this->dataValueSerializer, $serializeWithHash );
246		}
247
248		/**
249		* Returns a Serializer that can serialize TypedSnak objects.
250		*
251		* @param bool $serializeWithHash
252		*
253		* @since 1.3
254		*
255		* @return Serializer
256		*/
257	1	public function newTypedSnakSerializer( $serializeWithHash = true ) {
258	1	return new TypedSnakSerializer( $this->newSnakSerializer( $serializeWithHash ) );
259		}
260
261		/**
262		* Returns a Serializer that can serialize Term objects.
263		*
264		* @since 1.5
265		*
266		* @return Serializer
267		*/
268	12	public function newTermSerializer() {
269	12	return new TermSerializer();
270		}
271
272		/**
273		* Returns a Serializer that can serialize TermList objects.
274		*
275		* @since 1.5
276		*
277		* @return Serializer
278		*/
279	11	public function newTermListSerializer() {
280	11	return new TermListSerializer( $this->newTermSerializer(), $this->shouldUseObjectsForMaps() );
281		}
282
283		/**
284		* Returns a Serializer that can serialize AliasGroup objects.
285		*
286		* @since 1.6
287		*
288		* @return Serializer
289		*/
290	12	public function newAliasGroupSerializer() {
291	12	return new AliasGroupSerializer();
292		}
293
294		/**
295		* Returns a Serializer that can serialize AliasGroupList objects.
296		*
297		* @since 1.5
298		*
299		* @return Serializer
300		*/
301	11	public function newAliasGroupListSerializer() {
302	11	return new AliasGroupListSerializer( $this->newAliasGroupSerializer(), $this->shouldUseObjectsForMaps() );
303		}
304
305		}
306

wmde / WikibaseDataModelSerialization

Push — deprecations25 ( f844c9...90e697 )

SerializerFactory::newEntitySerializer() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like