SerializerFactory::newItemSerializer() - Code Metrics - Inspection of "Fix broken tests that do nothing or test wrong cla..." - wmde/WikibaseDataModelSerialization - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — brokenTests ( 6f3d3a )

by no

created 2016-02-16 11:54 UTC

SerializerFactory::newItemSerializer() A

↳ Parent: SerializerFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	9
rs	9.6666
cc	1
eloc	7
nc	1
nop	0

<?php

namespace Wikibase\DataModel;

use InvalidArgumentException;
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
 *
 * @licence GNU GPL v2+
 * @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 */
	const OPTION_SERIALIZE_MAIN_SNAKS_WITHOUT_HASH = 2;
	const OPTION_SERIALIZE_QUALIFIER_SNAKS_WITHOUT_HASH = 4;
	const OPTION_SERIALIZE_REFERENCE_SNAKS_WITHOUT_HASH = 8;

	/**
	 * @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 );
	}

	/**
	 * Returns a Serializer that can serialize Entity objects.
	 *
	 * @return Serializer
	 */
	public function newEntitySerializer() {
		return new DispatchingSerializer( array(
			$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\DispatchingSerializer;
7			use Serializers\Serializer;
8			use Wikibase\DataModel\Serializers\AliasGroupListSerializer;
9			use Wikibase\DataModel\Serializers\AliasGroupSerializer;
10			use Wikibase\DataModel\Serializers\ItemSerializer;
11			use Wikibase\DataModel\Serializers\PropertySerializer;
12			use Wikibase\DataModel\Serializers\ReferenceListSerializer;
13			use Wikibase\DataModel\Serializers\ReferenceSerializer;
14			use Wikibase\DataModel\Serializers\SiteLinkSerializer;
15			use Wikibase\DataModel\Serializers\SnakListSerializer;
16			use Wikibase\DataModel\Serializers\SnakSerializer;
17			use Wikibase\DataModel\Serializers\StatementListSerializer;
18			use Wikibase\DataModel\Serializers\StatementSerializer;
19			use Wikibase\DataModel\Serializers\TermListSerializer;
20			use Wikibase\DataModel\Serializers\TermSerializer;
21			use Wikibase\DataModel\Serializers\TypedSnakSerializer;
22
23			/**
24			* Factory for constructing Serializer objects that can serialize WikibaseDataModel objects.
25			*
26			* @since 0.1
27			*
28			* @licence GNU GPL v2+
29			* @author Thomas Pellissier Tanon
30			* @author Bene* < [email protected] >
31			* @author Addshore
32			*/
33			class SerializerFactory {
34
35			const OPTION_DEFAULT = 0;
36			/** @since 1.2.0 */
37			const OPTION_OBJECTS_FOR_MAPS = 1;
38			/** @since 1.7.0 */
39			const OPTION_SERIALIZE_MAIN_SNAKS_WITHOUT_HASH = 2;
40			const OPTION_SERIALIZE_QUALIFIER_SNAKS_WITHOUT_HASH = 4;
41			const OPTION_SERIALIZE_REFERENCE_SNAKS_WITHOUT_HASH = 8;
42
43			/**
44			* @var int
45			*/
46			private $options;
47
48			/**
49			* @var Serializer
50			*/
51			private $dataValueSerializer;
52
53			/**
54			* @param Serializer $dataValueSerializer serializer for DataValue objects
55			* @param int $options set multiple with bitwise or
56			*
57			* @throws InvalidArgumentException
58			*/
59			public function __construct( Serializer $dataValueSerializer, $options = 0 ) {
60			if ( !is_int( $options ) ) {
61			throw new InvalidArgumentException( '$options must be an integer' );
62			}
63
64			$this->dataValueSerializer = $dataValueSerializer;
65			$this->options = $options;
66			}
67
68			/**
69			* @return bool
70			*/
71			private function shouldUseObjectsForMaps() {
72			return (bool)( $this->options & self::OPTION_OBJECTS_FOR_MAPS );
73			}
74
75			/**
76			* @return bool
77			*/
78			private function shouldSerializeMainSnaksWithHash() {
79			return !(bool)( $this->options & self::OPTION_SERIALIZE_MAIN_SNAKS_WITHOUT_HASH );
80			}
81
82			/**
83			* @return bool
84			*/
85			private function shouldSerializeQualifierSnaksWithHash() {
86			return !(bool)( $this->options & self::OPTION_SERIALIZE_QUALIFIER_SNAKS_WITHOUT_HASH );
87			}
88
89			/**
90			* @return bool
91			*/
92			private function shouldSerializeReferenceSnaksWithHash() {
93			return !(bool)( $this->options & self::OPTION_SERIALIZE_REFERENCE_SNAKS_WITHOUT_HASH );
94			}
95
96			/**
97			* Returns a Serializer that can serialize Entity objects.
98			*
99			* @return Serializer
100			*/
101			public function newEntitySerializer() {
102			return new DispatchingSerializer( array(
103			$this->newItemSerializer(),
104			$this->newPropertySerializer()
105			) );
106			}
107
108			/**
109			* Returns a Serializer that can serialize Item objects.
110			*
111			* @since 2.1
112			*
113			* @return Serializer
114			*/
115			public function newItemSerializer() {
116			return new ItemSerializer(
117			$this->newTermListSerializer(),
118			$this->newAliasGroupListSerializer(),
119			$this->newStatementListSerializer(),
120			$this->newSiteLinkSerializer(),
121			$this->shouldUseObjectsForMaps()
122			);
123			}
124
125			/**
126			* Returns a Serializer that can serialize Property objects.
127			*
128			* @since 2.1
129			*
130			* @return Serializer
131			*/
132			public function newPropertySerializer() {
133			return new PropertySerializer(
134			$this->newTermListSerializer(),
135			$this->newAliasGroupListSerializer(),
136			$this->newStatementListSerializer()
137			);
138			}
139
140			/**
141			* Returns a Serializer that can serialize SiteLink objects.
142			*
143			* @return Serializer
144			*/
145			public function newSiteLinkSerializer() {
146			return new SiteLinkSerializer();
147			}
148
149			/**
150			* Returns a Serializer that can serialize StatementList objects.
151			*
152			* @since 1.4
153			*
154			* @return Serializer
155			*/
156			public function newStatementListSerializer() {
157			return new StatementListSerializer(
158			$this->newStatementSerializer(),
159			$this->shouldUseObjectsForMaps()
160			);
161			}
162
163			/**
164			* Returns a Serializer that can serialize Statement objects.
165			*
166			* @since 1.4
167			*
168			* @return Serializer
169			*/
170			public function newStatementSerializer() {
171			return new StatementSerializer(
172			$this->newSnakSerializer( $this->shouldSerializeMainSnaksWithHash() ),
173			$this->newSnakListSerializer( $this->shouldSerializeQualifierSnaksWithHash() ),
174			$this->newReferencesSerializer()
175			);
176			}
177
178			/**
179			* Returns a Serializer that can serialize ReferenceList objects.
180			*
181			* @return Serializer
182			*/
183			public function newReferencesSerializer() {
184			return new ReferenceListSerializer( $this->newReferenceSerializer() );
185			}
186
187			/**
188			* Returns a Serializer that can serialize Reference objects.
189			*
190			* @return Serializer
191			*/
192			public function newReferenceSerializer() {
193			return new ReferenceSerializer(
194			$this->newSnakListSerializer(
195			$this->shouldSerializeReferenceSnaksWithHash()
196			)
197			);
198			}
199
200			/**
201			* Returns a Serializer that can serialize SnakList objects.
202			*
203			* @param bool $serializeSnaksWithHash
204			*
205			* @since 1.4
206			*
207			* @return Serializer
208			*/
209			public function newSnakListSerializer( $serializeSnaksWithHash = true ) {
210			return new SnakListSerializer(
211			$this->newSnakSerializer( $serializeSnaksWithHash ),
212			$this->shouldUseObjectsForMaps()
213			);
214			}
215
216			/**
217			* Returns a Serializer that can serialize Snak objects.
218			*
219			* @param bool $serializeWithHash
220			*
221			* @return Serializer
222			*/
223			public function newSnakSerializer( $serializeWithHash = true ) {
224			return new SnakSerializer(
225			$this->dataValueSerializer,
226			$serializeWithHash
227			);
228			}
229
230			/**
231			* Returns a Serializer that can serialize TypedSnak objects.
232			*
233			* @param bool $serializeWithHash
234			*
235			* @since 1.3
236			*
237			* @return Serializer
238			*/
239			public function newTypedSnakSerializer( $serializeWithHash = true ) {
240			return new TypedSnakSerializer( $this->newSnakSerializer( $serializeWithHash ) );
241			}
242
243			/**
244			* Returns a Serializer that can serialize Term objects.
245			*
246			* @since 1.5
247			*
248			* @return Serializer
249			*/
250			public function newTermSerializer() {
251			return new TermSerializer();
252			}
253
254			/**
255			* Returns a Serializer that can serialize TermList objects.
256			*
257			* @since 1.5
258			*
259			* @return Serializer
260			*/
261			public function newTermListSerializer() {
262			return new TermListSerializer( $this->newTermSerializer(), $this->shouldUseObjectsForMaps() );
263			}
264
265			/**
266			* Returns a Serializer that can serialize AliasGroup objects.
267			*
268			* @since 1.6
269			*
270			* @return Serializer
271			*/
272			public function newAliasGroupSerializer() {
273			return new AliasGroupSerializer();
274			}
275
276			/**
277			* Returns a Serializer that can serialize AliasGroupList objects.
278			*
279			* @since 1.5
280			*
281			* @return Serializer
282			*/
283			public function newAliasGroupListSerializer() {
284			return new AliasGroupListSerializer( $this->newAliasGroupSerializer(), $this->shouldUseObjectsForMaps() );
285			}
286
287			}
288

wmde / WikibaseDataModelSerialization

Push — brokenTests ( 6f3d3a )

SerializerFactory::newItemSerializer() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like