Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | |
85.19% |
23 / 27 |
|
66.67% |
2 / 3 |
CRAP | |
0.00% |
0 / 1 |
ApiAddArticle | |
85.19% |
23 / 27 |
|
66.67% |
2 / 3 |
4.05 | |
0.00% |
0 / 1 |
execute | |
100.00% |
9 / 9 |
|
100.00% |
1 / 1 |
2 | |||
getAllowedParams | |
100.00% |
14 / 14 |
|
100.00% |
1 / 1 |
1 | |||
getExamplesMessages | |
0.00% |
0 / 4 |
|
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 MediaWiki\Extension\Collection\Specials\SpecialCollection; |
27 | use Wikimedia\ParamValidator\ParamValidator; |
28 | |
29 | class ApiAddArticle extends ApiBase { |
30 | use CollectionTrait; |
31 | |
32 | /** |
33 | * execute the API request |
34 | */ |
35 | public function execute() { |
36 | $params = $this->extractRequestParams(); |
37 | $articleAdded = SpecialCollection::addArticleFromName( |
38 | $params['namespace'], |
39 | $params['title'], |
40 | $params['oldid'] |
41 | ); |
42 | |
43 | if ( !$articleAdded ) { |
44 | $this->dieWithError( 'coll-api-addarticle-article-not-added' ); |
45 | } |
46 | |
47 | $this->getCollectionItemListAfterAction(); |
48 | } |
49 | |
50 | public function getAllowedParams() { |
51 | return [ |
52 | 'namespace' => [ |
53 | ParamValidator::PARAM_TYPE => 'integer', |
54 | ParamValidator::PARAM_REQUIRED => true, |
55 | ], |
56 | 'title' => [ |
57 | ParamValidator::PARAM_TYPE => 'string', |
58 | ParamValidator::PARAM_REQUIRED => true, |
59 | ], |
60 | 'oldid' => [ |
61 | ParamValidator::PARAM_TYPE => 'integer', |
62 | ParamValidator::PARAM_DEFAULT => 0, |
63 | ], |
64 | ]; |
65 | } |
66 | |
67 | /** |
68 | * @return array examples of the use of this API module |
69 | */ |
70 | protected function getExamplesMessages(): array { |
71 | return [ |
72 | 'action=collection&submodule=addarticle&namespace=0&title=Main_Page&oldid=0' |
73 | => 'apihelp-collection+addarticle-example', |
74 | ]; |
75 | } |
76 | } |