mediawiki-extensions-Discus.../includes/SubscriptionItem.php
Bartosz Dziewoński 8bb36bd782 Add API to get the status of topic subscriptions on a page
(Split off from Ic0fabda0de4ebbc5e424f49641e6b03ebb4b7e6a)

Bug: T290185
Change-Id: Iacc0f92bedfcb49e8a05d98af4d8170d08b1c8de
2021-09-07 21:38:09 +00:00

101 lines
2.1 KiB
PHP

<?php
namespace MediaWiki\Extension\DiscussionTools;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\User\UserIdentity;
/**
* Representation of a subscription to a given topic.
*/
class SubscriptionItem {
private $itemName;
private $linkTarget;
private $user;
private $state;
private $createdTimestamp;
private $notifiedTimestamp;
/**
* @param UserIdentity $user
* @param string $itemName
* @param LinkTarget $linkTarget
* @param int $state One of SubscriptionStore::STATE_* constants
* @param string|null $createdTimestamp When the subscription was created
* @param string|null $notifiedTimestamp When the item subscribed to last tried to trigger
* a notification (even if muted).
*/
public function __construct(
UserIdentity $user,
string $itemName,
linkTarget $linkTarget,
int $state,
?string $createdTimestamp,
?string $notifiedTimestamp
) {
$this->user = $user;
$this->itemName = $itemName;
$this->linkTarget = $linkTarget;
$this->state = $state;
$this->createdTimestamp = $createdTimestamp;
$this->notifiedTimestamp = $notifiedTimestamp;
}
/**
* @return UserIdentity
*/
public function getUserIdentity(): UserIdentity {
return $this->user;
}
/**
* @return string
*/
public function getItemName(): string {
return $this->itemName;
}
/**
* @return LinkTarget
*/
public function getLinkTarget(): LinkTarget {
return $this->linkTarget;
}
/**
* Get the creation timestamp of this entry.
*
* @return string|null
*/
public function getCreatedTimestamp() {
return $this->createdTimestamp;
}
/**
* Get the notification timestamp of this entry.
*
* @return string|null
*/
public function getNotificationTimestamp() {
return $this->notifiedTimestamp;
}
/**
* Get the subscription status of this entry.
*
* @return int One of SubscriptionStore::STATE_* constants
*/
public function getState(): int {
return $this->state;
}
/**
* Check if the notification is muted
*
* @return bool
*/
public function isMuted(): bool {
return $this->state === SubscriptionStore::STATE_UNSUBSCRIBED;
}
}