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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
<?php
/*
* Copyright (c) 2016 The MITRE Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
namespace MediaWiki\Extension\CommentStreams;
use ApiBase;
use ApiMain;
use ApiUsageException;
class ApiCSVote extends ApiCSBase {
/**
* @param ApiMain $main main module
* @param string $action name of this module
*/
public function __construct( ApiMain $main, string $action ) {
parent::__construct( $main, $action, true );
}
/**
* the real body of the execute function
* @return ?array result of API request
* @throws ApiUsageException
*/
protected function executeBody() : ?array {
if ( $this->getUser()->isAnon() ) {
$this->dieWithError( 'commentstreams-api-error-vote-notloggedin' );
}
$vote = $this->getMain()->getVal( 'vote' );
if ( $this->comment->getParentId() !== null ) {
$this->dieWithError( 'commentstreams-api-error-vote-novoteonreply' );
}
$result = $this->comment->vote( $vote, $this->getUser() );
if ( !$result ) {
$this->dieWithError( 'commentstreams-api-error-vote' );
}
return null;
}
/**
* @return array allowed parameters
*/
public function getAllowedParams() : array {
return array_merge( parent::getAllowedParams(),
[
'vote' =>
[
ApiBase::PARAM_TYPE => 'integer',
ApiBase::PARAM_REQUIRED => true
]
]
);
}
/**
* @return array examples of the use of this API module
*/
public function getExamplesMessages() : array {
return [
'action=' . $this->getModuleName() . '&pageid=3&vote=1' =>
'apihelp-' . $this->getModuleName() . '-pageid-example',
'action=' . $this->getModuleName() . '&title=CommentStreams:3&vote=-1' =>
'apihelp-' . $this->getModuleName() . '-title-example'
];
}
/**
* @return string indicates that this API module requires a CSRF toekn
*/
public function needsToken() : string {
return 'csrf';
}
}
|
GitWeb