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