Page MenuHomeWickedGov Phorge
Files F5993200

ApiEchoPushSubscriptionsDelete.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ApiEchoPushSubscriptionsDelete.php
View Options

<?php
namespace MediaWiki\Extension\Notifications\Push\Api;
use MediaWiki\Api\ApiBase;
use MediaWiki\Api\ApiMain;
use MediaWiki\Api\ApiUsageException;
use MediaWiki\Extension\Notifications\Push\SubscriptionManager;
use MediaWiki\Extension\Notifications\Push\Utils;
use MediaWiki\Extension\Notifications\Services;
use Wikimedia\ParamValidator\ParamValidator;
class ApiEchoPushSubscriptionsDelete extends ApiBase {
/** @var ApiBase */
private $parent;
/** @var SubscriptionManager */
private $subscriptionManager;
/**
* Static entry point for initializing the module
* @param ApiBase $parent Parent module
* @param string $name Module name
* @return ApiEchoPushSubscriptionsDelete
*/
public static function factory( ApiBase $parent, string $name ): ApiEchoPushSubscriptionsDelete {
$subscriptionManager = Services::getInstance()->getPushSubscriptionManager();
$module = new self( $parent->getMain(), $name, $subscriptionManager );
$module->parent = $parent;
return $module;
}
public function __construct(
ApiMain $mainModule,
string $moduleName,
SubscriptionManager $subscriptionManager
) {
parent::__construct( $mainModule, $moduleName );
$this->subscriptionManager = $subscriptionManager;
}
/**
* Entry point for executing the module.
* @inheritDoc
*/
public function execute(): void {
$tokens = $this->getParameter( 'providertoken' );
$userId = null;
if ( !$tokens ) {
$this->dieWithError( [ 'apierror-paramempty', 'providertoken' ], 'paramempty_providertoken' );
}
// Restrict deletion to the user's own token(s) if not a push subscription manager
try {
$this->checkUserRightsAny( 'manage-all-push-subscriptions' );
} catch ( ApiUsageException $e ) {
$userId = Utils::getPushUserId( $this->getUser() );
}
$numRowsDeleted = $this->subscriptionManager->delete( $tokens, $userId );
if ( $numRowsDeleted == 0 ) {
$this->dieWithError( 'apierror-echo-push-token-not-found' );
}
}
/**
* Get the parent module.
* @return ApiBase
*/
public function getParent(): ApiBase {
return $this->parent;
}
/** @inheritDoc */
protected function getAllowedParams(): array {
return [
'providertoken' => [
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
ParamValidator::PARAM_ISMULTI => true,
],
];
}
/** @inheritDoc */
protected function getExamplesMessages(): array {
return [
"action=echopushsubscriptions&command=delete&providertoken=ABC123" =>
"apihelp-echopushsubscriptions+delete-example"
];
}
// The parent module already enforces these but they make documentation nicer.
/** @inheritDoc */
public function isWriteMode(): bool {
return true;
}
/** @inheritDoc */
public function mustBePosted(): bool {
return true;
}
/** @inheritDoc */
public function isInternal(): bool {
// experimental!
return true;
}
}

File Metadata

Mime Type
text/x-php
Expires
Oct 4 2026, 02:37 (4 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
cd/a2/2fd4e7cfcfb51a40288a2632dfc7
Default Alt Text
ApiEchoPushSubscriptionsDelete.php (2 KB)

Event Timeline