Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
69.23% |
9 / 13 |
|
66.67% |
2 / 3 |
CRAP | |
0.00% |
0 / 1 |
| ApiAddCategory | |
69.23% |
9 / 13 |
|
66.67% |
2 / 3 |
3.26 | |
0.00% |
0 / 1 |
| execute | |
100.00% |
3 / 3 |
|
100.00% |
1 / 1 |
1 | |||
| getAllowedParams | |
100.00% |
6 / 6 |
|
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 MediaWiki\Api\ApiBase; |
| 26 | use MediaWiki\Extension\Collection\Specials\SpecialCollection; |
| 27 | use Wikimedia\ParamValidator\ParamValidator; |
| 28 | |
| 29 | class ApiAddCategory extends ApiBase { |
| 30 | use CollectionTrait; |
| 31 | |
| 32 | /** |
| 33 | * execute the API request |
| 34 | */ |
| 35 | public function execute() { |
| 36 | $params = $this->extractRequestParams(); |
| 37 | /* $articlesAdded = */ SpecialCollection::addCategoryFromName( $params['title'], $this->getConfig() ); |
| 38 | |
| 39 | // TODO: There is an issue with ::addCategoryFromName that makes successfully |
| 40 | // adding articles within a category to the book to return false instead |
| 41 | // of true. That is in the case where the number of articles in the category |
| 42 | // is not greater than the limit. Limit exceeded will never be true hence |
| 43 | // the check below for $articlesAdded will always pass hence needs fixing. |
| 44 | /* if ( !$articlesAdded ) { |
| 45 | $this->dieWithError( 'coll-api-addcategory-category-does-not-exist' ); |
| 46 | } */ |
| 47 | |
| 48 | $this->getCollectionItemListAfterAction(); |
| 49 | } |
| 50 | |
| 51 | /** @inheritDoc */ |
| 52 | public function getAllowedParams() { |
| 53 | return [ |
| 54 | // this really should be 'category' instead of 'title' |
| 55 | 'title' => [ |
| 56 | ParamValidator::PARAM_TYPE => 'string', |
| 57 | ParamValidator::PARAM_DEFAULT => '', |
| 58 | ], |
| 59 | ]; |
| 60 | } |
| 61 | |
| 62 | /** |
| 63 | * @return array examples of the use of this API module |
| 64 | */ |
| 65 | protected function getExamplesMessages(): array { |
| 66 | return [ |
| 67 | 'action=collection&submodule=addcategory&title=Main_Page' |
| 68 | => 'apihelp-collection+addcategory-example', |
| 69 | ]; |
| 70 | } |
| 71 | } |