1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Wikibase\DataModel\Snak; |
4
|
|
|
|
5
|
|
|
use InvalidArgumentException; |
6
|
|
|
use Traversable; |
7
|
|
|
use Wikibase\DataModel\HashArray; |
8
|
|
|
use Wikibase\DataModel\Internal\MapValueHasher; |
9
|
|
|
|
10
|
|
|
/** |
11
|
|
|
* List of Snak objects. |
12
|
|
|
* Indexes the snaks by hash and ensures no more the one snak with the same hash are in the list. |
13
|
|
|
* |
14
|
|
|
* @since 0.1 |
15
|
|
|
* |
16
|
|
|
* @license GPL-2.0+ |
17
|
|
|
* @author Jeroen De Dauw < [email protected] > |
18
|
|
|
* @author Addshore |
19
|
|
|
*/ |
20
|
|
|
class SnakList extends HashArray { |
21
|
|
|
|
22
|
|
|
/** |
23
|
|
|
* @param Snak[]|Traversable $snaks |
24
|
|
|
* |
25
|
|
|
* @throws InvalidArgumentException |
26
|
|
|
*/ |
27
|
7 |
|
public function __construct( $snaks = [] ) { |
28
|
7 |
|
if ( !is_array( $snaks ) && !( $snaks instanceof Traversable ) ) { |
29
|
|
|
throw new InvalidArgumentException( '$snaks must be an array or an instance of Traversable' ); |
30
|
|
|
} |
31
|
|
|
|
32
|
|
|
foreach ( $snaks as $index => $snak ) { |
33
|
|
|
$this->setElement( $index, $snak ); |
34
|
|
|
} |
35
|
|
|
} |
36
|
|
|
|
37
|
|
|
/** |
38
|
|
|
* @see GenericArrayObject::getObjectType |
39
|
|
|
* |
40
|
3 |
|
* @since 0.1 |
41
|
3 |
|
* |
42
|
|
|
* @return string |
43
|
|
|
*/ |
44
|
|
|
public function getObjectType() { |
45
|
|
|
return 'Wikibase\DataModel\Snak\Snak'; |
46
|
|
|
} |
47
|
|
|
|
48
|
|
|
/** |
49
|
|
|
* @since 0.1 |
50
|
|
|
* |
51
|
5 |
|
* @param string $snakHash |
52
|
5 |
|
* |
53
|
5 |
|
* @return boolean |
54
|
|
|
*/ |
55
|
|
|
public function hasSnakHash( $snakHash ) { |
56
|
|
|
return $this->hasElementHash( $snakHash ); |
57
|
|
|
} |
58
|
|
|
|
59
|
|
|
/** |
60
|
|
|
* @since 0.1 |
61
|
|
|
* |
62
|
|
|
* @param string $snakHash |
63
|
|
|
*/ |
64
|
10 |
|
public function removeSnakHash( $snakHash ) { |
65
|
10 |
|
$this->removeByElementHash( $snakHash ); |
66
|
|
|
} |
67
|
|
|
|
68
|
|
|
/** |
69
|
|
|
* @since 0.1 |
70
|
|
|
* |
71
|
|
|
* @param Snak $snak |
72
|
|
|
* |
73
|
|
|
* @return boolean Indicates if the snak was added or not. |
74
|
|
|
*/ |
75
|
|
|
public function addSnak( Snak $snak ) { |
76
|
|
|
return $this->addElement( $snak ); |
77
|
11 |
|
} |
78
|
11 |
|
|
79
|
|
|
/** |
80
|
|
|
* @since 0.1 |
81
|
|
|
* |
82
|
|
|
* @param Snak $snak |
83
|
|
|
* |
84
|
|
|
* @return boolean |
85
|
|
|
*/ |
86
|
|
|
public function hasSnak( Snak $snak ) { |
87
|
|
|
return $this->hasElementHash( $snak->getHash() ); |
88
|
13 |
|
} |
89
|
13 |
|
|
90
|
13 |
|
/** |
91
|
|
|
* @since 0.1 |
92
|
|
|
* |
93
|
|
|
* @param Snak $snak |
94
|
|
|
*/ |
95
|
|
|
public function removeSnak( Snak $snak ) { |
96
|
|
|
$this->removeByElementHash( $snak->getHash() ); |
97
|
|
|
} |
98
|
|
|
|
99
|
|
|
/** |
100
|
|
|
* @since 0.1 |
101
|
|
|
* |
102
|
|
|
* @param string $snakHash |
103
|
|
|
* |
104
|
|
|
* @return Snak|bool |
105
|
|
|
*/ |
106
|
|
|
public function getSnak( $snakHash ) { |
107
|
|
|
return $this->getByElementHash( $snakHash ); |
108
|
|
|
} |
109
|
|
|
|
110
|
|
|
/** |
111
|
|
|
* @see HashArray::getHash |
112
|
7 |
|
* |
113
|
7 |
|
* @since 0.5 |
114
|
7 |
|
* |
115
|
|
|
* @return string |
116
|
|
|
*/ |
117
|
|
|
public function getHash() { |
118
|
|
|
$hasher = new MapValueHasher(); |
119
|
|
|
return $hasher->hash( $this ); |
120
|
|
|
} |
121
|
|
|
|
122
|
|
|
/** |
123
|
|
|
* Orders the snaks in the list grouping them by property. |
124
|
7 |
|
* |
125
|
7 |
|
* @param string[] $order List of serliazed property ids to order by. |
126
|
7 |
|
* |
127
|
|
|
* @since 0.5 |
128
|
7 |
|
*/ |
129
|
6 |
|
public function orderByProperty( array $order = [] ) { |
130
|
5 |
|
$snaksByProperty = $this->getSnaksByProperty(); |
131
|
5 |
|
$orderedProperties = array_unique( array_merge( $order, array_keys( $snaksByProperty ) ) ); |
132
|
5 |
|
|
133
|
7 |
|
foreach ( $orderedProperties as $property ) { |
134
|
7 |
|
if ( array_key_exists( $property, $snaksByProperty ) ) { |
135
|
|
|
$snaks = $snaksByProperty[$property]; |
136
|
|
|
$this->moveSnaksToBottom( $snaks ); |
137
|
|
|
} |
138
|
|
|
} |
139
|
5 |
|
} |
140
|
5 |
|
|
141
|
5 |
|
/** |
142
|
5 |
|
* @param Snak[] $snaks to remove and re add |
143
|
5 |
|
*/ |
144
|
5 |
|
private function moveSnaksToBottom( array $snaks ) { |
145
|
|
|
foreach ( $snaks as $snak ) { |
146
|
|
|
$this->removeSnak( $snak ); |
147
|
|
|
$this->addSnak( $snak ); |
148
|
|
|
} |
149
|
|
|
} |
150
|
|
|
|
151
|
|
|
/** |
152
|
7 |
|
* Gets the snaks in the current object in an array |
153
|
7 |
|
* grouped by property id |
154
|
|
|
* |
155
|
7 |
|
* @return array[] |
156
|
|
|
*/ |
157
|
5 |
|
private function getSnaksByProperty() { |
158
|
5 |
|
$snaksByProperty = []; |
159
|
5 |
|
|
160
|
5 |
|
foreach ( $this as $snak ) { |
161
|
5 |
|
/** @var Snak $snak */ |
162
|
7 |
|
$propertyId = $snak->getPropertyId()->getSerialization(); |
163
|
|
|
if ( !isset( $snaksByProperty[$propertyId] ) ) { |
164
|
7 |
|
$snaksByProperty[$propertyId] = []; |
165
|
|
|
} |
166
|
|
|
$snaksByProperty[$propertyId][] = $snak; |
167
|
|
|
} |
168
|
|
|
|
169
|
|
|
return $snaksByProperty; |
170
|
|
|
} |
171
|
|
|
|
172
|
|
|
} |
173
|
|
|
|