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
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Linter;
use MediaWiki\Json\FormatJson;
/**
* Model to represent a LintError
*/
class LintError {
/**
* @var string
*/
public $category;
/**
* @var int[] [ start, end ]
*/
public $location;
/**
* @var int
*/
public $lintId;
/**
* @var array
*/
public $params;
/**
* @var array|null
*/
public $templateInfo;
/**
* @var string|null
*/
public $tagInfo;
/**
* Optional hint for the linter category ID.
* Passed through from Parsoid when a new category has been added
* that isn't known to PHP yet.
* @var int|null
*/
public $catId;
/**
* @param string $category
* @param int[] $location [ start, end ]
* @param string|array $params JSON string or already decoded array
* @param int|null $catId Optional category ID hint
* @param int $lintId Optional linter_id
*/
public function __construct( $category, $location, $params, $catId = null, $lintId = 0 ) {
$this->category = $category;
$this->catId = $catId;
if ( is_string( $params ) ) {
$params = FormatJson::decode( $params, true );
}
$this->params = $params;
$this->lintId = $lintId;
$this->location = $location;
// Convenient accessors for all errors
$this->templateInfo = $params['templateInfo'] ?? null;
$this->tagInfo = $params['name'] ?? null;
}
/**
* Unique id to identify this error, for internal
* purposes
*
* @return string
*/
public function id() {
return $this->category . ",{$this->location[0]},{$this->location[1]},"
. FormatJson::encode( $this->params );
}
/**
* Get the params that are extra for this error,
* not part of the default set
*
* @return array
*/
public function getExtraParams() {
$params = $this->params;
unset( $params['templateInfo'] );
return $params;
}
}
|
