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
|
<?php
namespace Maps\MediaWiki\ParserHooks;
use Maps\Presentation\MapsDistanceParser;
use ParserHook;
/**
* Class for the 'distance' parser hooks,
* which can transform the notation of a distance.
*
* @licence GNU GPL v2+
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
class DistanceFunction extends ParserHook {
/**
* Renders and returns the output.
*
* @see ParserHook::render
*
* @param array $parameters
*
* @return string
*/
public function render( array $parameters ) {
return MapsDistanceParser::formatDistance(
$parameters['distance'],
$parameters['unit'],
$parameters['decimals']
);
}
/**
* @see ParserHook::getMessage()
*/
public function getMessage() {
return 'maps-distance-description';
}
/**
* Gets the name of the parser hook.
*
* @see ParserHook::getName
*
* @return string
*/
protected function getName() {
return 'distance';
}
/**
* Returns an array containing the parameter info.
*
* @see ParserHook::getParameterInfo
*
* @return array
*/
protected function getParameterInfo( $type ) {
global $egMapsDistanceUnit, $egMapsDistanceDecimals;
$params = [];
$params['distance'] = [
'type' => 'distance',
];
$params['unit'] = [
'default' => $egMapsDistanceUnit,
'values' => MapsDistanceParser::getUnits(),
];
$params['decimals'] = [
'type' => 'integer',
'default' => $egMapsDistanceDecimals,
];
// Give grep a chance to find the usages:
// maps-distance-par-distance, maps-distance-par-unit, maps-distance-par-decimals
foreach ( $params as $name => &$param ) {
$param['message'] = 'maps-distance-par-' . $name;
}
return $params;
}
/**
* Returns the list of default parameters.
*
* @see ParserHook::getDefaultParameters
*
* @param $type
*
* @return array
*/
protected function getDefaultParameters( $type ) {
return [ 'distance', 'unit', 'decimals' ];
}
}
|
