Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | |
74.07% |
20 / 27 |
|
66.67% |
2 / 3 |
CRAP | |
0.00% |
0 / 1 |
ApiSetTitles | |
74.07% |
20 / 27 |
|
66.67% |
2 / 3 |
4.28 | |
0.00% |
0 / 1 |
execute | |
100.00% |
6 / 6 |
|
100.00% |
1 / 1 |
2 | |||
getAllowedParams | |
100.00% |
14 / 14 |
|
100.00% |
1 / 1 |
1 | |||
getExamplesMessages | |
0.00% |
0 / 7 |
|
0.00% |
0 / 1 |
2 |
1 | <?php |
2 | |
3 | /* |
4 | * Permission is hereby granted, free of charge, to any person obtaining a |
5 | * copy of this software and associated documentation files (the "Software"), |
6 | * to deal in the Software without restriction, including without limitation |
7 | * the rights to use, copy, modify, merge, publish, distribute, sublicense, |
8 | * and/or sell copies of the Software, and to permit persons to whom the |
9 | * Software is furnished to do so, subject to the following conditions: |
10 | * |
11 | * The above copyright notice and this permission notice shall be included in |
12 | * all copies or substantial portions of the Software. |
13 | * |
14 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
15 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
16 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
17 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
18 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
19 | * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
20 | * DEALINGS IN THE SOFTWARE. |
21 | */ |
22 | |
23 | namespace MediaWiki\Extension\Collection\Api; |
24 | |
25 | use ApiBase; |
26 | use FormatJson; |
27 | use MediaWiki\Extension\Collection\Specials\SpecialCollection; |
28 | use Wikimedia\ParamValidator\ParamValidator; |
29 | |
30 | class ApiSetTitles extends ApiBase { |
31 | use CollectionTrait; |
32 | |
33 | /** |
34 | * execute the API request |
35 | */ |
36 | public function execute() { |
37 | [ 'title' => $title, 'subtitle' => $subtitle, 'settings' => $settings ] = $this->extractRequestParams(); |
38 | |
39 | SpecialCollection::setTitles( $title, $subtitle ); |
40 | $settings = FormatJson::decode( $settings, true ); |
41 | if ( is_array( $settings ) ) { |
42 | SpecialCollection::setSettings( $settings ); |
43 | } |
44 | $this->getCollectionItemListAfterAction(); |
45 | } |
46 | |
47 | /** @inheritDoc */ |
48 | public function getAllowedParams() { |
49 | return [ |
50 | 'title' => [ |
51 | ParamValidator::PARAM_TYPE => 'string', |
52 | ParamValidator::PARAM_REQUIRED => true |
53 | ], |
54 | 'subtitle' => [ |
55 | ParamValidator::PARAM_TYPE => 'string', |
56 | ParamValidator::PARAM_DEFAULT => '' |
57 | ], |
58 | 'settings' => [ |
59 | ParamValidator::PARAM_TYPE => 'string', |
60 | ParamValidator::PARAM_DEFAULT => '' |
61 | ], |
62 | ]; |
63 | } |
64 | |
65 | /** |
66 | * @return array examples of the use of this API module |
67 | */ |
68 | protected function getExamplesMessages(): array { |
69 | return [ |
70 | 'action=collection&submodule=settitles&title=foo&subtitle=bar' |
71 | => 'apihelp-collection+settitles-example', |
72 | 'action=collection&submodule=settitles&title=foo&subtitle=bar&' . |
73 | 'settings={"papersize":"a4","toc":"auto","columns":"2"}' |
74 | => 'apihelp-collection+settitles-settings-example' |
75 | ]; |
76 | } |
77 | } |