Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
81.48% |
22 / 27 |
|
66.67% |
2 / 3 |
CRAP | |
0.00% |
0 / 1 |
| ApiPostCollection | |
81.48% |
22 / 27 |
|
66.67% |
2 / 3 |
4.10 | |
0.00% |
0 / 1 |
| execute | |
100.00% |
16 / 16 |
|
100.00% |
1 / 1 |
2 | |||
| getAllowedParams | |
100.00% |
6 / 6 |
|
100.00% |
1 / 1 |
1 | |||
| getExamplesMessages | |
0.00% |
0 / 5 |
|
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\Json\FormatJson; |
| 27 | use MediaWiki\Session\SessionManager; |
| 28 | use MediaWiki\SpecialPage\SpecialPage; |
| 29 | use Wikimedia\ParamValidator\ParamValidator; |
| 30 | |
| 31 | class ApiPostCollection extends ApiBase { |
| 32 | use CollectionTrait; |
| 33 | |
| 34 | /** |
| 35 | * execute the API request |
| 36 | */ |
| 37 | public function execute() { |
| 38 | $session = SessionManager::getGlobalSession(); |
| 39 | $session->persist(); |
| 40 | |
| 41 | $params = $this->extractRequestParams(); |
| 42 | $collection = FormatJson::decode( $params['collection'], true ); |
| 43 | $apiResults = $this->getResult(); |
| 44 | |
| 45 | if ( $collection === null ) { |
| 46 | $this->dieWithError( 'coll-api-invalid-collection' ); |
| 47 | } |
| 48 | |
| 49 | $collection['enabled'] = true; |
| 50 | $session['wsCollection'] = $collection; |
| 51 | |
| 52 | $title = SpecialPage::getTitleFor( 'Book' ); |
| 53 | $redirecturl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT ); |
| 54 | $apiResults->addValue( |
| 55 | null, |
| 56 | 'response message', |
| 57 | FormatJson::encode( [ 'redirect_url' => $redirecturl ] ) |
| 58 | ); |
| 59 | } |
| 60 | |
| 61 | /** @inheritDoc */ |
| 62 | public function getAllowedParams() { |
| 63 | return [ |
| 64 | 'collection' => [ |
| 65 | ParamValidator::PARAM_TYPE => 'string', |
| 66 | ParamValidator::PARAM_DEFAULT => '', |
| 67 | ], |
| 68 | ]; |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * @return array examples of the use of this API module |
| 73 | */ |
| 74 | protected function getExamplesMessages(): array { |
| 75 | return [ |
| 76 | 'action=collection&submodule=postcollection&collection={"title":"BookTitle","items":[{"type":"article", |
| 77 | "content_type":"text/x-wiki","title":"Test","revision":"1","latest":"1","timestamp":"1631548781", |
| 78 | "url":"http://t.wiki/Test","currentVersion":1}]}' |
| 79 | => 'apihelp-collection+postcollection-example', |
| 80 | ]; |
| 81 | } |
| 82 | } |