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
|
<?php
/**
* Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
* Copyright © 2008 Brooke Vibber <bvibber@wikimedia.org>
* Copyright © 2014 Wikimedia Foundation and contributors
*
* 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\Api;
/**
* @ingroup API
*/
class ApiOpenSearchFormatJson extends ApiFormatJson {
/** @var bool */
private $warningsAsError;
public function __construct( ApiMain $main, string $fm, $warningsAsError ) {
parent::__construct( $main, "json$fm" );
$this->warningsAsError = $warningsAsError;
}
public function execute() {
$result = $this->getResult();
if ( !$result->getResultData( 'error' ) && !$result->getResultData( 'errors' ) ) {
// Ignore warnings or treat as errors, as requested
$warnings = $result->removeValue( 'warnings', null );
if ( $this->warningsAsError && $warnings ) {
$this->dieWithError(
'apierror-opensearch-json-warnings',
'warnings',
[ 'warnings' => $warnings ]
);
}
// Ignore any other unexpected keys (e.g. from $wgDebugToolbar)
$remove = array_keys( array_diff_key(
$result->getResultData(),
[ 0 => 'search', 1 => 'terms', 2 => 'descriptions', 3 => 'urls' ]
) );
foreach ( $remove as $key ) {
$result->removeValue( $key, null );
}
}
parent::execute();
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiOpenSearchFormatJson::class, 'ApiOpenSearchFormatJson' );
|
