summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/Api/Browse/ListAugmentor.php
blob: e02aa118309c9cadf018a48bd82edf9118dd55ae (plain)
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
<?php

namespace SMW\MediaWiki\Api\Browse;

use SMW\ApplicationFactory;
use SMW\DIProperty;
use SMW\SQLStore\SQLStore;
use SMW\Store;

/**
 * @license GNU GPL v2+
 * @since 3.0
 *
 * @author mwjames
 */
class ListAugmentor {

	/**
	 * @var Store
	 */
	private $store;

	/**
	 * @since 3.0
	 *
	 * @param Store $store
	 */
	public function __construct( Store $store ) {
		$this->store = $store;
	}

	/**
	 * @since 3.0
	 *
	 * @param array &$res
	 * @param array $parameters
	 *
	 * @return array
	 */
	public function augment( array &$res, array $parameters ) {

		if ( !isset( $res['query'] ) && $res['query'] === [] ) {
			return;
		}

		$type = null;
		$lang = 'en';

		if ( isset( $res['meta']['type'] ) ) {
			$type = $res['meta']['type'];
		}

		if ( isset( $parameters['lang'] ) ) {
			$lang = $parameters['lang'];
		}

		if ( is_string( $lang ) ) {
			$lang = [ $lang ];
		}

		if ( $type === 'property' && isset( $parameters['description' ] ) ) {
			$this->addPropertyDescription( $res, $lang );
		}

		if ( $type === 'property' && isset( $parameters['prefLabel' ] ) ) {
			$this->addPreferredPropertyLabel( $res, $lang );
		}

		if ( $type === 'property' && isset( $parameters['usageCount' ] ) ) {
			$this->addUsageCount( $res );
		}

		// Remove the internal ID, no external consumer should rely on it
		foreach ( $res['query'] as $key => &$value ) {
			unset( $value['id'] );
		}

		return $res;
	}

	private function addUsageCount( &$res ) {

		$list = $res['query'];

		$db = $this->store->getConnection( 'mw.db' );

		foreach ( $list as $key => $value ) {

			$row = $db->selectRow(
				SQLStore::PROPERTY_STATISTICS_TABLE,
				[ 'usage_count' ],
				[
					'p_id' => $value['id']
				],
				__METHOD__
			);

			$list[$key] = $value + [
				'usageCount' => $row->usage_count
			];
		}

		$res['query'] = $list;
	}

	private function addPreferredPropertyLabel( &$res, array $languageCodes ) {

		$list = $res['query'];

		foreach ( $list as $key => $value ) {
			$property = new DIProperty( $key );
			$prefLabel = [];

			foreach ( $languageCodes as $code ) {
				$prefLabel[$code] = $property->getPreferredLabel( $code );
			}

			$list[$key] = $value + [
				'prefLabel' => $prefLabel
			];
		}

		$res['query'] = $list;
	}

	private function addPropertyDescription( &$res, array $languageCodes ) {

		$list = $res['query'];
		$propertySpecificationLookup = ApplicationFactory::getInstance()->getPropertySpecificationLookup();

		foreach ( $list as $key => $value ) {
			$property = new DIProperty( $key );
			$description = [];

			foreach ( $languageCodes as $code ) {
				$description[$code] = $propertySpecificationLookup->getPropertyDescriptionByLanguageCode( $property, $code );
			}

			$list[$key] = $value + [
				'description' => $description
			];
		}

		$res['query'] = $list;
	}

}