Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7421694
ApiDiscussionToolsGetSubscriptions.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
1 KB
Referenced Files
None
Subscribers
None
ApiDiscussionToolsGetSubscriptions.php
View Options
<?php
namespace
MediaWiki\Extension\DiscussionTools
;
use
MediaWiki\Api\ApiBase
;
use
MediaWiki\Api\ApiMain
;
use
MediaWiki\Api\ApiUsageException
;
use
Wikimedia\ParamValidator\ParamValidator
;
class
ApiDiscussionToolsGetSubscriptions
extends
ApiBase
{
private
SubscriptionStore
$subscriptionStore
;
public
function
__construct
(
ApiMain
$main
,
string
$name
,
SubscriptionStore
$subscriptionStore
)
{
parent
::
__construct
(
$main
,
$name
);
$this
->
subscriptionStore
=
$subscriptionStore
;
}
/**
* @inheritDoc
* @throws ApiUsageException
*/
public
function
execute
()
{
$user
=
$this
->
getUser
();
if
(
!
$user
->
isNamed
()
)
{
$this
->
dieWithError
(
'apierror-mustbeloggedin-generic'
,
'notloggedin'
);
}
$params
=
$this
->
extractRequestParams
();
$itemNames
=
$params
[
'commentname'
];
$items
=
$this
->
subscriptionStore
->
getSubscriptionItemsForUser
(
$user
,
$itemNames
);
// Ensure consistent formatting in JSON and XML formats
$this
->
getResult
()->
addIndexedTagName
(
'subscriptions'
,
'subscription'
);
$this
->
getResult
()->
addArrayType
(
'subscriptions'
,
'kvp'
,
'name'
);
foreach
(
$items
as
$item
)
{
$this
->
getResult
()->
addValue
(
'subscriptions'
,
$item
->
getItemName
(),
$item
->
getState
()
);
}
}
/**
* @inheritDoc
*/
public
function
getAllowedParams
()
{
return
[
'commentname'
=>
[
ParamValidator
::
PARAM_REQUIRED
=>
true
,
ParamValidator
::
PARAM_ISMULTI
=>
true
,
],
];
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 05:35 (1 d, 2 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
44/1f/5f4e18e962316798e0ac4f8ee2c7
Default Alt Text
ApiDiscussionToolsGetSubscriptions.php (1 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment