summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticResultFormats/formats/filtered/src/View/CalendarView.php
blob: 0ac5441b57d541a2de70c9bbe472037e3da557e4 (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
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
<?php

namespace SRF\Filtered\View;

/**
 * File holding the CalendarView class
 *
 * @author Stephan Gambke
 * @file
 * @ingroup SemanticResultFormats
 */

use Message;
use SRF\Filtered\ResultItem;

/**
 * The CalendarView class defines the List view.
 *
 * Available parameters for this view:
 *   list view type: list|ul|ol; default: list
 *   list view template: a template rendering a list item
 *   list view introtemplate: a template prepended to the list
 *   list view outrotemplate: a template appended to the list
 *   list view named args: use named args for templates
 *
 * @ingroup SemanticResultFormats
 */
class CalendarView extends View {

	private $start;
	private $end;
	private $title;
	private $titleTemplate;

	/**
	 * @param ResultItem $row
	 *
	 * @return array
	 */
	public function getJsDataForRow( ResultItem $row ) {

		$value = $row->getValue();
		$data = [];
		$wikitext = '';

		foreach ( $value as $valueId => $field ) {

			$printRequest = $field->getPrintRequest();

			$field->reset();
			$datavalue = $field->getNextDataValue();

			if ( $datavalue instanceof \SMWTimeValue &&
				( $printRequest->getLabel() === $this->start || $this->start === null && !array_key_exists(
						'start',
						$data
					) )
			) {
				// found specified column for start date
				// OR no column for start date specified, take first available date value
				$data['start'] = $datavalue->getISO8601Date();
			}

			if ( $datavalue instanceof \SMWTimeValue && $printRequest->getLabel() === $this->end ) {
				// found specified column for end date
				$data['end'] = $datavalue->getISO8601Date();
			}

			if ( $this->titleTemplate === null &&
				( $printRequest->getLabel() === $this->title || $this->title === null && !array_key_exists(
						'title',
						$data
					) )
			) {
				// found specified column for title
				if ( $datavalue !== false ) {
					if ( $datavalue instanceof \SMWWikiPageValue ) {
						$data['url'] = $datavalue->getDataItem()->getTitle()->getLocalURL();
					}
					$data['title'] = $datavalue->getShortHTMLText();
				}
			}

			// only add to title template if requested and if not hidden
			if ( $this->titleTemplate !== null && filter_var(
					$printRequest->getParameter( 'hide' ),
					FILTER_VALIDATE_BOOLEAN
				) === false ) {

				$params = [];
				while ( ( $text = $field->getNextText(
						SMW_OUTPUT_WIKI,
						$this->getQueryPrinter()->getLinker( $valueId === 0 )
					) ) !== false ) {
					$params[] = $text;
				}
				$wikitext .= '|' . ( $valueId + 1 ) . '=' . join( ',', $params );
			}

		}

		// only add to title template if requested and if not hidden
		if ( $this->titleTemplate !== null ) {
//			$wikitext .= "|#=$rownum";
			$data['title'] = trim(
				$this->getQueryPrinter()->getParser()->recursiveTagParse(
					'{{' . $this->titleTemplate . $wikitext . '}}'
				)
			);
			$this->getQueryPrinter()->getParser()->replaceLinkHolders( $data['title'] );
		}

		return $data;
	}

	/**
	 * Transfers the parameters applicable to this view into internal variables.
	 */
	protected function handleParameters() {

		$params = $this->getActualParameters();
		$parser = $this->getQueryPrinter()->getParser();

		// find the hash for the printout containing the start date
		if ( $params['calendar view start'] !== '' ) {
			$this->start = trim( $parser->recursiveTagParse( $params['calendar view start'] ) );
		}

		// find the hash for the printout containing the start date
		if ( $params['calendar view end'] !== '' ) {
			$this->end = trim( $parser->recursiveTagParse( $params['calendar view end'] ) );
		}

		// find the hash for the printout containing the title of the element
		if ( $params['calendar view title'] !== '' ) {
			$this->title = trim( $parser->recursiveTagParse( $params['calendar view title'] ) );
		}

		// find the hash for the printout containing the title of the element
		if ( $params['calendar view title template'] !== '' ) {
			$this->titleTemplate = trim( $parser->recursiveTagParse( $params['calendar view title template'] ) );
		}

//		$this->mTemplate = $params['list view template'];
//		$this->mIntroTemplate = $params['list view introtemplate'];
//		$this->mOutroTemplate = $params['list view outrotemplate'];
//		$this->mNamedArgs = $params['list view named args'];
//
//		if ( $params['headers'] == 'hide' ) {
//			$this->mShowHeaders = SMW_HEADERS_HIDE;
//		} elseif ( $params['headers'] == 'plain' ) {
//			$this->mShowHeaders = SMW_HEADERS_PLAIN;
//		} else {
//			$this->mShowHeaders = SMW_HEADERS_SHOW;
//		}
	}

	/**
	 * A function to describe the allowed parameters of a query for this view.
	 *
	 * @return array of Parameter
	 */
	public static function getParameters() {
		$params = parent::getParameters();

		$params[] = [
			// 'type' => 'string',
			'name' => 'calendar view start',
			'message' => 'srf-paramdesc-filtered-calendar-start',
			'default' => '',
			// 'islist' => false,
		];

		$params[] = [
			// 'type' => 'string',
			'name' => 'calendar view end',
			'message' => 'srf-paramdesc-filtered-calendar-end',
			'default' => '',
			// 'islist' => false,
		];

		$params[] = [
			// 'type' => 'string',
			'name' => 'calendar view title',
			'message' => 'srf-paramdesc-filtered-calendar-title',
			'default' => '',
			// 'islist' => false,
		];

		$params[] = [
			// 'type' => 'string',
			'name' => 'calendar view title template',
			'message' => 'srf-paramdesc-filtered-calendar-title-template',
			'default' => '',
			// 'islist' => false,
		];

		return $params;
	}

	/**
	 * Returns the name of the resource module to load for this view.
	 *
	 * @return string|array
	 */
	public function getResourceModules() {
		return 'ext.srf.filtered.calendar-view';
	}

	/**
	 * Returns an array of config data for this filter to be stored in the JS
	 *
	 * @return string[]
	 */
	public function getJsConfig() {
		global $wgAmericanDates;

		return
			$this->getParamHashes( $this->getQueryResults(), $this->getActualParameters() ) +
			[
				'firstDay' => ( $wgAmericanDates ? '0' : Message::newFromKey(
					'srf-filtered-firstdayofweek'
				)->inContentLanguage()->text() ),
				'isRTL' => wfGetLangObj( true )->isRTL(),
			];
	}

	/**
	 * @param ResultItem[] $results
	 * @param string[] $params
	 *
	 * @return string[]
	 */
	private function getParamHashes( $results, $params ) {

		if ( $results === null || count( $results ) < 1 ) {
			return [];
		}

		if ( $params['calendar view title'] !== '' ) {

			$titleLabel = trim(
				$this->getQueryPrinter()->getParser()->recursiveTagParse( $params['calendar view title'] )
			);

			// find the hash for the printout containing the title of the element
			foreach ( reset( $results )->getValue() as $printout ) {

				if ( $printout->getPrintRequest()->getLabel() === $titleLabel ) {
					return [ 'title' => $this->getQueryPrinter()->uniqid( $printout->getPrintRequest()->getHash() ) ];
				}
			}

		} elseif ( $params['mainlabel'] !== '-' ) { // first column not suppressed
			$value = reset( $results )->getValue();
			return [ 'title' => $this->getQueryPrinter()->uniqid( reset( $value )->getPrintRequest()->getHash() ) ];
		}

		return [];
	}

	/**
	 * Returns the label of the selector for this view.
	 *
	 * @return String the selector label
	 */
	public function getSelectorLabel() {
		return Message::newFromKey( 'srf-filtered-selectorlabel-calendar' )->inContentLanguage()->text();
	}

}