mediawiki-extensions-Echo/includes/Push/Subscription.php
Umherirrender d7556b1d96 Add missing @var and improve documentation
Change-Id: I729d5ff5afd4d45022fa0a4e42d060d35543b567
2020-12-17 20:55:49 +01:00

69 lines
1.4 KiB
PHP

<?php
namespace EchoPush;
use Wikimedia\Timestamp\ConvertibleTimestamp;
class Subscription {
/** @var string */
private $provider;
/** @var string */
private $token;
/** @var ConvertibleTimestamp */
private $updated;
/** @var string|null */
private $topic;
/**
* Construct a subscription from a DB result row.
* @param \stdClass $row echo_push_subscription row from IResultWrapper::fetchRow
* @return Subscription
*/
public static function newFromRow( object $row ) {
return new self(
$row->epp_name,
$row->eps_token,
$row->ept_text,
new ConvertibleTimestamp( $row->eps_updated )
);
}
/**
* @param string $provider
* @param string $token
* @param string|null $topic
* @param ConvertibleTimestamp $updated
*/
public function __construct( string $provider, string $token, ?string $topic, ConvertibleTimestamp $updated ) {
$this->provider = $provider;
$this->token = $token;
$this->topic = $topic;
$this->updated = $updated;
}
/** @return string provider */
public function getProvider(): string {
return $this->provider;
}
/** @return string token */
public function getToken(): string {
return $this->token;
}
/** @return string|null topic */
public function getTopic(): ?string {
return $this->topic;
}
/** @return ConvertibleTimestamp last updated timestamp */
public function getUpdated(): ConvertibleTimestamp {
return $this->updated;
}
}