summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/DataValues/ValueFormatters/NumberValueFormatter.php
blob: a9a50f2bebc051eb970bcc291c4f799902ff48c0 (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
<?php

namespace SMW\DataValues\ValueFormatters;

use RuntimeException;
use SMW\Highlighter;
use SMWDataValue as DataValue;
use SMWNumberValue as NumberValue;

/**
 * @license GNU GPL v2+
 * @since 2.4
 *
 * @author mwjames
 */
class NumberValueFormatter extends DataValueFormatter {

	/**
	 * @since 2.4
	 *
	 * {@inheritDoc}
	 */
	public function isFormatterFor( DataValue $dataValue ) {
		return $dataValue instanceof NumberValue;
	}

	/**
	 * @since 2.4
	 *
	 * {@inheritDoc}
	 */
	public function format( $type, $linker = null ) {

		if ( !$this->dataValue instanceof NumberValue ) {
			throw new RuntimeException( "The formatter is missing a valid NumberValue object" );
		}

		if ( $type === self::VALUE ) {
			return $this->valueFormat();
		}

		if ( $type === self::WIKI_SHORT || $type === self::HTML_SHORT ) {
			return $this->shortFormat( $linker );
		}

		if ( $type === self::WIKI_LONG || $type === self::HTML_LONG ) {
			return $this->longFormat( $linker );
		}

		return 'UNKNOWN';
	}

	private function valueFormat() {

		if ( !$this->dataValue->isValid() ) {
			return 'error';
		}

		$unit = $this->dataValue->getUnit();

		$number = $this->dataValue->getNormalizedFormattedNumber(
			$this->dataValue->getNumber()
		);

		if ( $unit === '' ) {
			return $number;
		}

		return $this->dataValue->hasPrefixalUnitPreference( $unit ) ? $unit . ' ' . $number : $number . ' ' . $unit;
	}

	private function shortFormat( $linker = null ) {

		$outformat = $this->dataValue->getOutputFormat();

		if ( $linker === null || ( $linker === false ) || ( $outformat == '-' ) || ( $outformat == '-u' ) || ( $outformat == '-n' ) || !$this->dataValue->isValid() ) {
			return $this->dataValue->getCaption();
		}

		$convertedUnitValues = $this->dataValue->getConvertedUnitValues();
		$tooltip = '';

		$i = 0;

		foreach ( $convertedUnitValues as $unit => $value ) {
			if ( $unit != $this->dataValue->getCanonicalMainUnit() ) {
				$number = $this->dataValue->getLocalizedFormattedNumber( $value );
				if ( $unit !== '' ) {
					$tooltip .= $this->dataValue->hasPrefixalUnitPreference( $unit ) ? $unit . '&#160;' . $number : $number . '&#160;' . $unit;
				} else{
					$tooltip .= $number;
				}
				$tooltip .= ' <br />';
				$i++;
				if ( $i >= 5 ) { // limit number of printouts in tooltip
					break;
				}
			}
		}

		if ( $tooltip === '' ) {
			return $this->dataValue->getCaption();
		}

		$highlighter = Highlighter::factory(
			Highlighter::TYPE_QUANTITY,
			$this->dataValue->getOption( DataValue::OPT_USER_LANGUAGE )
		);

		$highlighter->setContent(
			[
				'caption' => $this->dataValue->getCaption(),
				'content' => $tooltip
			]
		);

		return $highlighter->getHtml();
	}

	private function longFormat( $linker = null ) {

		if ( !$this->dataValue->isValid() ) {
			return $this->dataValue->getErrorText();
		}

		$outformat = $this->dataValue->getOutputFormat();
		$convertedUnitValues = $this->dataValue->getConvertedUnitValues();

		$result = '';
		$i = 0;

		foreach ( $convertedUnitValues as $unit => $value ) {

			if ( $i == 1 ) {
				$result .= ' (';
			} elseif ( $i > 1 ) {
				$result .= ', ';
			}

			$number = ( $outformat != '-' ? $this->dataValue->getLocalizedFormattedNumber( $value ) : $value );

			if ( $unit !== '' ) {
				$result .= $this->dataValue->hasPrefixalUnitPreference( $unit ) ? $unit . '&#160;' . $number : $number . '&#160;' . $unit;
			} else {
				$result .= $number;
			}

			$i++;

			if ( $outformat == '-' ) { // no further conversions for plain output format
				break;
			}
		}

		if ( $i > 1 ) {
			$result .= ')';
		}

		return $result;
	}

}