Code Coverage for /workspace/src/extensions/WikibaseSchema/src/Services/SchemaConverter/SchemaConverter.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total	0.00% covered (danger)	0.00%	0 / 1	46.15% covered (danger)	46.15%	6 / 13	CRAP	81.30% covered (warning)	81.30%	100 / 123
EntitySchema\Services\SchemaConverter\SchemaConverter	0.00% covered (danger)	0.00%	0 / 1	46.15% covered (danger)	46.15%	6 / 13	68.01	81.30% covered (warning)	81.30%	100 / 123
getFullViewSchemaData				100.00% covered (success)	100.00%	1 / 1	1	100.00% covered (success)	100.00%	4 / 4
getMonolingualNameBadgeData				100.00% covered (success)	100.00%	1 / 1	1	100.00% covered (success)	100.00%	5 / 5
getFullArraySchemaData				100.00% covered (success)	100.00%	1 / 1	5	100.00% covered (success)	100.00%	14 / 14
getPersistenceSchemaData				100.00% covered (success)	100.00%	1 / 1	5	100.00% covered (success)	100.00%	14 / 14
getSchemaID				100.00% covered (success)	100.00%	1 / 1	1	100.00% covered (success)	100.00%	1 / 1
getIdFromSchema				0.00% covered (danger)	0.00%	0 / 1	5.93	66.67% covered (warning)	66.67%	6 / 9
getSchemaText				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 2
getSchemaTextFromSchema				0.00% covered (danger)	0.00%	0 / 1	5.68	70.00% covered (warning)	70.00%	7 / 10
getNameBadgesFromSchema				100.00% covered (success)	100.00%	1 / 1	2	100.00% covered (success)	100.00%	8 / 8
getSchemaLanguages				0.00% covered (danger)	0.00%	0 / 1	4.16	78.57% covered (warning)	78.57%	11 / 14
getLabelFromSchema				0.00% covered (danger)	0.00%	0 / 1	8.14	71.43% covered (warning)	71.43%	10 / 14
getDescriptionFromSchema				0.00% covered (danger)	0.00%	0 / 1	8.14	71.43% covered (warning)	71.43%	10 / 14
getAliasGroupFromSchema				0.00% covered (danger)	0.00%	0 / 1	8.14	71.43% covered (warning)	71.43%	10 / 14

1	<?php
2
3	namespace EntitySchema\Services\SchemaConverter;
4
5	use DomainException;
6	use LogicException;
7
8	/**
9	* Convert schema data for different uses from the persistence format
10	*
11	* @license GPL-2.0-or-later
12	*/
13	class SchemaConverter {
14
15	/**
16	* @param string $schemaJSON
17	* @param string[] $preferredLanguages Name badges for these language codes will always be present,
18	* even if there is no data for them, and they will also be ordered before other languages.
19	*
20	* @return FullViewSchemaData
21	*
22	* @throws LogicException
23	*/
24	public function getFullViewSchemaData(
25	$schemaJSON,
26	array $preferredLanguages
27	): FullViewSchemaData {
28	$schema = json_decode( $schemaJSON, true );
29
30	return new FullViewSchemaData(
31	$this->getNameBadgesFromSchema( $schema, $preferredLanguages ),
32	$this->getSchemaTextFromSchema( $schema )
33	);
34	}
35
36	/**
37	* @param string $schemaData
38	* @param string $langCode
39	*
40	* @return NameBadge
41	*
42	*/
43	public function getMonolingualNameBadgeData( $schemaData, $langCode ): NameBadge {
44	$schema = json_decode( $schemaData, true );
45
46	return new NameBadge(
47	$this->getLabelFromSchema( $schema, $langCode ),
48	$this->getDescriptionFromSchema( $schema, $langCode ),
49	$this->getAliasGroupFromSchema( $schema, $langCode )
50	);
51	}
52
53	public function getFullArraySchemaData( $schemaJSON ): FullArraySchemaData {
54	$schema = json_decode( $schemaJSON, true );
55
56	$data = [
57	'labels' => [],
58	'descriptions' => [],
59	'aliases' => [],
60	'schemaText' => $this->getSchemaTextFromSchema( $schema ),
61	];
62
63	foreach ( $this->getSchemaLanguages( $schema ) as $languageCode ) {
64	$label = $this->getLabelFromSchema( $schema, $languageCode );
65	if ( $label ) {
66	$data['labels'][$languageCode] = $label;
67	}
68	$description = $this->getDescriptionFromSchema( $schema, $languageCode );
69	if ( $description ) {
70	$data['descriptions'][$languageCode] = $description;
71	}
72	$aliases = $this->getAliasGroupFromSchema( $schema, $languageCode );
73	if ( $aliases ) {
74	$data['aliases'][$languageCode] = $aliases;
75	}
76	}
77
78	return new FullArraySchemaData( $data );
79	}
80
81	public function getPersistenceSchemaData( $schemaJSON ): PersistenceSchemaData {
82	$schema = json_decode( $schemaJSON, true );
83	$persistenceSchemaData = new PersistenceSchemaData();
84	$persistenceSchemaData->schemaText = $this->getSchemaTextFromSchema( $schema );
85
86	foreach ( $this->getSchemaLanguages( $schema ) as $languageCode ) {
87	$label = $this->getLabelFromSchema( $schema, $languageCode );
88	if ( $label ) {
89	$persistenceSchemaData->labels[$languageCode] = $label;
90	}
91	$description = $this->getDescriptionFromSchema( $schema, $languageCode );
92	if ( $description ) {
93	$persistenceSchemaData->descriptions[$languageCode] = $description;
94	}
95	$aliases = $this->getAliasGroupFromSchema( $schema, $languageCode );
96	if ( $aliases ) {
97	$persistenceSchemaData->aliases[$languageCode] = $aliases;
98	}
99	}
100
101	return $persistenceSchemaData;
102	}
103
104	public function getSchemaID( $schemaJSON ) {
105	return $this->getIdFromSchema( json_decode( $schemaJSON, true ) );
106	}
107
108	private function getIdFromSchema( array $schema ) {
109	if ( !isset( $schema['serializationVersion'] ) ) {
110	return null;
111	}
112
113	switch ( $schema['serializationVersion'] ) {
114	case '1.0':
115	case '2.0':
116	case '3.0':
117	return $schema['id'] ?? null;
118	default:
119	throw new DomainException(
120	'Unknown schema serialization version ' . $schema['serializationVersion']
121	);
122	}
123	}
124
125	/**
126	* @param string $schemaJSON
127	*
128	* @return string
129	*/
130	public function getSchemaText( $schemaJSON ) {
131	$schema = json_decode( $schemaJSON, true );
132	return $this->getSchemaTextFromSchema( $schema );
133	}
134
135	private function getSchemaTextFromSchema( array $schema ) {
136	if ( !isset( $schema['serializationVersion'] ) ) {
137	return '';
138	}
139
140	switch ( $schema['serializationVersion'] ) {
141	case '1.0':
142	case '2.0':
143	return $schema['schema'] ?? '';
144	case '3.0':
145	return $schema['schemaText'] ?? '';
146	default:
147	throw new DomainException(
148	'Unknown schema serialization version ' . $schema['serializationVersion']
149	);
150	}
151	}
152
153	/**
154	* @param array $schema
155	* @param string[] $preferredLanguages
156	*
157	* @return NameBadge[]
158	*
159	* @throws DomainException
160	*/
161	private function getNameBadgesFromSchema( array $schema, array $preferredLanguages ): array {
162	$langs = $this->getSchemaLanguages( $schema, $preferredLanguages );
163	$nameBadges = [];
164	foreach ( $langs as $langCode ) {
165	$nameBadges[$langCode] = new NameBadge(
166	$this->getLabelFromSchema( $schema, $langCode ),
167	$this->getDescriptionFromSchema( $schema, $langCode ),
168	$this->getAliasGroupFromSchema( $schema, $langCode )
169	);
170	}
171	return $nameBadges;
172	}
173
174	/**
175	* @param array $schema
176	* @param string[] $preferredLanguages
177	*
178	* @return string[]
179	*/
180	private function getSchemaLanguages( $schema, array $preferredLanguages = [] ) {
181	$langs = $preferredLanguages;
182	if ( !empty( $schema['labels'] ) ) {
183	$langs = array_merge(
184	$langs,
185	array_keys( $schema['labels'] )
186	);
187	}
188	if ( !empty( $schema['descriptions'] ) ) {
189	$langs = array_merge(
190	$langs,
191	array_keys( $schema['descriptions'] )
192	);
193	}
194	if ( !empty( $schema['aliases'] ) ) {
195	$langs = array_merge(
196	$langs,
197	array_keys( $schema['aliases'] )
198	);
199	}
200	return array_unique( $langs );
201	}
202
203	/**
204	* @param array $schema
205	* @param string $langCode
206	*
207	* @return string
208	*
209	* @throws DomainException
210	*/
211	private function getLabelFromSchema( array $schema, $langCode ) {
212	if ( empty( $schema['labels'] ) ) {
213	return '';
214	}
215
216	if ( !isset( $schema['serializationVersion'] ) ) {
217	return '';
218	}
219
220	switch ( $schema['serializationVersion'] ) {
221	case '1.0':
222	if ( isset( $schema['labels'][$langCode] ) ) {
223	return $schema['labels'][$langCode]['value'];
224	}
225	return '';
226	case '2.0':
227	case '3.0':
228	return $schema['labels'][$langCode] ?? '';
229	default:
230	throw new DomainException(
231	'Unknown schema serialization version ' . $schema['serializationVersion']
232	);
233	}
234	}
235
236	/**
237	* @param array $schema
238	* @param string $langCode
239	*
240	* @return string
241	*
242	* @throws DomainException
243	*/
244	private function getDescriptionFromSchema( array $schema, $langCode ) {
245	if ( empty( $schema['descriptions'] ) ) {
246	return '';
247	}
248
249	if ( !isset( $schema['serializationVersion'] ) ) {
250	return '';
251	}
252
253	switch ( $schema['serializationVersion'] ) {
254	case '1.0':
255	if ( isset( $schema['descriptions'][$langCode] ) ) {
256	return $schema['descriptions'][$langCode]['value'];
257	}
258	return '';
259	case '2.0':
260	case '3.0':
261	return $schema['descriptions'][$langCode] ?? '';
262	default:
263	throw new DomainException(
264	'Unknown schema serialization version ' . $schema['serializationVersion']
265	);
266	}
267	}
268
269	/**
270	* @param array $schema
271	* @param string $langCode
272	*
273	* @return array
274	*
275	* @throws DomainException
276	*/
277	private function getAliasGroupFromSchema( array $schema, $langCode ) {
278	if ( empty( $schema['aliases'] ) ) {
279	return [];
280	}
281
282	if ( !isset( $schema['serializationVersion'] ) ) {
283	return [];
284	}
285
286	switch ( $schema['serializationVersion'] ) {
287	case '1.0':
288	if ( isset( $schema['aliases'][$langCode] ) ) {
289	return array_column( $schema['aliases'][$langCode], 'value' );
290	}
291	return [];
292	case '2.0':
293	case '3.0':
294	return $schema['aliases'][$langCode] ?? [];
295	default:
296	throw new DomainException(
297	'Unknown schema serialization version ' . $schema['serializationVersion']
298	);
299	}
300	}
301
302	}