-
Notifications
You must be signed in to change notification settings - Fork 56
/
TypeDispatchingEntityStore.php
234 lines (211 loc) · 5 KB
/
TypeDispatchingEntityStore.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<?php
namespace Wikibase\Lib\Store;
use InvalidArgumentException;
use MWException;
use PermissionsError;
use User;
use Wikibase\DataModel\Entity\EntityDocument;
use Wikibase\DataModel\Entity\EntityId;
use Wikibase\DataModel\Entity\EntityRedirect;
/**
* An EntityStore that does dispatching based on the entity type.
*
* @license GPL-2.0-or-later
* @author Thiemo Kreuz
*/
class TypeDispatchingEntityStore implements EntityStore {
/**
* @var array indexed by entity type
*/
private $stores;
/**
* @var EntityStore
*/
private $defaultStore;
/**
* @var EntityRevisionLookup
*/
private $lookup;
/**
* @param callable[] $callbacks indexed by entity type
* @param EntityStore $defaultStore
* @param EntityRevisionLookup $lookup
*/
public function __construct(
array $callbacks,
EntityStore $defaultStore,
EntityRevisionLookup $lookup
) {
$this->stores = $callbacks;
$this->defaultStore = $defaultStore;
$this->lookup = $lookup;
}
/**
* @see EntityStore::assignFreshId
*
* @param EntityDocument $entity
*
* @throws StorageException
*/
public function assignFreshId( EntityDocument $entity ) {
$this->getStore( $entity->getType() )->assignFreshId( $entity );
}
/**
* @see EntityStore::saveEntity
*
* @param EntityDocument $entity
* @param string $summary
* @param User $user
* @param int $flags
* @param int|bool $baseRevId
* @param string[] $tags
*
* @throws StorageException
* @throws PermissionsError
* @return EntityRevision
*/
public function saveEntity(
EntityDocument $entity,
$summary,
User $user,
$flags = 0,
$baseRevId = false,
array $tags = []
) {
return $this->getStore( $entity->getType() )->saveEntity(
$entity,
$summary,
$user,
$flags,
$baseRevId,
$tags
);
}
/**
* @see EntityStore::saveRedirect
*
* @param EntityRedirect $redirect
* @param string $summary
* @param User $user
* @param int $flags
* @param int|bool $baseRevId
*
* @throws StorageException
* @throws PermissionsError
* @return int The new revision ID
*/
public function saveRedirect(
EntityRedirect $redirect,
$summary,
User $user,
$flags = 0,
$baseRevId = false
) {
return $this->getStore( $redirect->getEntityId()->getEntityType() )->saveRedirect(
$redirect,
$summary,
$user,
$flags,
$baseRevId
);
}
/**
* @see EntityStore::deleteEntity
*
* @param EntityId $entityId
* @param string $reason
* @param User $user
*/
public function deleteEntity( EntityId $entityId, $reason, User $user ) {
$this->getStore( $entityId->getEntityType() )->deleteEntity( $entityId, $reason, $user );
}
/**
* @see EntityStore::userWasLastToEdit
*
* @param User $user
* @param EntityId $id
* @param int $lastRevId
*
* @return bool
*/
public function userWasLastToEdit( User $user, EntityId $id, $lastRevId ) {
return $this->getStore( $id->getEntityType() )->userWasLastToEdit( $user, $id, $lastRevId );
}
/**
* @see EntityStore::updateWatchlist
*
* @param User $user
* @param EntityId $id
* @param bool $watch
*
* @throws MWException
*/
public function updateWatchlist( User $user, EntityId $id, $watch ) {
$this->getStore( $id->getEntityType() )->updateWatchlist( $user, $id, $watch );
}
/**
* @see EntityStore::isWatching
*
* @param User $user
* @param EntityId $id
*
* @return bool
*/
public function isWatching( User $user, EntityId $id ) {
return $this->getStore( $id->getEntityType() )->isWatching( $user, $id );
}
/**
* @see EntityStore::canCreateWithCustomId
*
* @param EntityId $id
*
* @return bool
*/
public function canCreateWithCustomId( EntityId $id ) {
return $this->getStore( $id->getEntityType() )->canCreateWithCustomId( $id );
}
/**
* @param string $entityType
*
* @throws InvalidArgumentException
* @return EntityStore
*/
private function getStore( $entityType ) {
if ( !array_key_exists( $entityType, $this->stores ) ) {
return $this->defaultStore;
}
if ( is_callable( $this->stores[$entityType] ) ) {
$this->stores[$entityType] = call_user_func(
$this->stores[$entityType],
$this->defaultStore,
$this->lookup
);
if ( !( $this->stores[$entityType] instanceof EntityStore ) ) {
throw new InvalidArgumentException(
"Callback provided for $entityType did not create an EntityStore"
);
}
}
return $this->stores[$entityType];
}
/**
* @internal
* @deprecated This is only here to overcome a violation introduced in
* https://gerrit.wikimedia.org/r/357812 as part of https://phabricator.wikimedia.org/T162533
*
* @param EntityId $entityId
*
* @throws \LogicException
* @return \WikiPage
*/
public function getWikiPageForEntity( EntityId $entityId ) {
$store = $this->getStore( $entityId->getEntityType() );
if ( !method_exists( $store, 'getWikiPageForEntity' )
|| !defined( 'MW_PHPUNIT_TEST' )
) {
throw new \LogicException( 'Do not use' );
}
// @phan-suppress-next-line PhanUndeclaredMethod
return $store->getWikiPageForEntity( $entityId );
}
}