Completed
Push — master ( 06ffb3...1e5bde )
by
unknown
02:34
created

deserializeArgument()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 23
Code Lines 16

Duplication

Lines 8
Ratio 34.78 %

Importance

Changes 0
Metric Value
dl 8
loc 23
rs 9.0856
c 0
b 0
f 0
cc 2
eloc 16
nc 2
nop 2
1
<?php
2
3
namespace WikibaseQuality\ConstraintReport\ConstraintCheck\Message;
4
5
use Deserializers\Deserializer;
6
use InvalidArgumentException;
7
use Wikibase\DataModel\Entity\EntityId;
8
use Wikibase\DataModel\Entity\EntityIdParser;
9
use WikibaseQuality\ConstraintReport\ConstraintCheck\ItemIdSnakValue;
10
use Wikimedia\Assert\Assert;
11
12
/**
13
 * A deserializer for {@link ViolationMessage}s.
14
 *
15
 * @license GNU GPL v2+
16
 */
17
class ViolationMessageDeserializer implements Deserializer {
18
19
	/**
20
	 * @var EntityIdParser
21
	 */
22
	private $entityIdParser;
23
24
	public function __construct(
25
		EntityIdParser $entityIdParser
26
	) {
27
		$this->entityIdParser = $entityIdParser;
28
	}
29
30
	public function unabbreviateViolationMessageKey( $messageKeySuffix ) {
31
		return ViolationMessage::MESSAGE_KEY_PREFIX . $messageKeySuffix;
32
	}
33
34
	/**
35
	 * @param array $serialization
36
	 * @return ViolationMessage
37
	 */
38
	public function deserialize( $serialization ) {
39
		Assert::parameterType( 'array', $serialization, '$serialization' );
40
41
		$message = new ViolationMessage(
42
			$this->unabbreviateViolationMessageKey( $serialization['k'] )
43
		);
44
45
		foreach ( $serialization['a'] as $serializedArgument ) {
46
			$message = $this->deserializeArgument( $message, $serializedArgument );
47
		}
48
49
		return $message;
50
	}
51
52
	/**
53
	 * @param ViolationMessage $message
54
	 * @param array $serializedArgument [ 't' => ViolationMessage::TYPE_*, 'v' => serialized value, 'r' => $role ]
55
	 * @return ViolationMessage $message with the deserialized argument appended
56
	 */
57
	private function deserializeArgument( ViolationMessage $message, array $serializedArgument ) {
58
		$methods = [
59
			ViolationMessage::TYPE_ENTITY_ID => 'deserializeEntityId',
60
			ViolationMessage::TYPE_ENTITY_ID_LIST => 'deserializeEntityIdList',
61
			ViolationMessage::TYPE_ITEM_ID_SNAK_VALUE => 'deserializeItemIdSnakValue',
62
			ViolationMessage::TYPE_ITEM_ID_SNAK_VALUE_LIST => 'deserializeItemIdSnakValueList',
63
		];
64
65
		$type = $serializedArgument['t'];
66
		$serializedValue = $serializedArgument['v'];
67
		$role = $serializedArgument['r'];
68
69 View Code Duplication
		if ( array_key_exists( $type, $methods ) ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
70
			$method = $methods[$type];
71
			$value = $this->$method( $serializedValue );
72
		} else {
73
			throw new InvalidArgumentException(
74
				'Unknown ViolationMessage argument type ' . $type . '!'
75
			);
76
		}
77
78
		return $message->withArgument( $type, $role, $value );
79
	}
80
81
	/**
82
	 * @param string $entityIdSerialization entity ID serialization
83
	 * @return EntityId
84
	 */
85
	private function deserializeEntityId( $entityIdSerialization ) {
86
		return $this->entityIdParser->parse( $entityIdSerialization );
87
	}
88
89
	/**
90
	 * @param string[] $entityIdSerializations entity ID serializations
91
	 * @return EntityId[]
92
	 */
93
	private function deserializeEntityIdList( array $entityIdSerializations ) {
94
		return array_map( [ $this, 'deserializeEntityId' ], $entityIdSerializations );
95
	}
96
97
	/**
98
	 * @param string $valueSerialization entity ID serialization, '::somevalue' or '::novalue'
99
	 * @return ItemIdSnakValue
100
	 */
101
	private function deserializeItemIdSnakValue( $valueSerialization ) {
102
		switch ( $valueSerialization ) {
103
			case '::somevalue':
104
				return ItemIdSnakValue::someValue();
105
			case '::novalue':
106
				return ItemIdSnakValue::noValue();
107
			default:
108
				return ItemIdSnakValue::fromItemId( $this->deserializeEntityId( $valueSerialization ) );
0 ignored issues
show
Compatibility introduced by
$this->deserializeEntityId($valueSerialization) of type object<Wikibase\DataModel\Entity\EntityId> is not a sub-type of object<Wikibase\DataModel\Entity\ItemId>. It seems like you assume a child class of the class Wikibase\DataModel\Entity\EntityId to be always present.

This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass.

Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type.

Loading history...
109
		}
110
	}
111
112
	/**
113
	 * @param string[] $valueSerializations entity ID serializations, '::somevalue's or '::novalue's
114
	 * @return ItemIdSnakValue[]
115
	 */
116
	private function deserializeItemIdSnakValueList( $valueSerializations ) {
117
		return array_map( [ $this, 'deserializeItemIdSnakValue' ], $valueSerializations );
118
	}
119
120
}
121