mediawiki-extensions-Discus.../includes/SubscriptionItem.php
libraryupgrader b0884b177c build: Updating dependencies
composer:
* mediawiki/mediawiki-codesniffer: 36.0.0 → 37.0.0

npm:
* postcss: 7.0.35 → 7.0.36
  * https://npmjs.com/advisories/1693 (CVE-2021-23368)
* glob-parent: 5.1.1 → 5.1.2
  * https://npmjs.com/advisories/1751 (CVE-2020-28469)
* trim-newlines: 3.0.0 → 3.0.1
  * https://npmjs.com/advisories/1753 (CVE-2021-33623)

Change-Id: I7a71e23da561599da417db3b3077b78d91173bbc
2021-07-22 16:29:04 +00:00

92 lines
1.9 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 1/0 for watched/muted
* @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;
}
/**
* Check if the notification is muted
*
* @return bool
*/
public function isMuted(): bool {
return $this->state === 0;
}
}