MediaWiki  1.29.2
WatchedItem.php
Go to the documentation of this file.
1 <?php
23 
32 class WatchedItem {
33 
38 
43 
48 
54 
59  private $title;
60 
64  private $linkTarget;
65 
69  private $user;
70 
75 
82  public function __construct(
83  User $user,
86  $checkRights = null
87  ) {
88  $this->user = $user;
89  $this->linkTarget = $linkTarget;
90  $this->notificationTimestamp = $notificationTimestamp;
91  if ( $checkRights !== null ) {
92  $this->checkRights = $checkRights;
93  }
94  }
95 
99  public function getUser() {
100  return $this->user;
101  }
102 
106  public function getLinkTarget() {
107  return $this->linkTarget;
108  }
109 
115  public function getNotificationTimestamp() {
116  // Back compat for objects constructed using self::fromUserTitle
117  if ( $this->notificationTimestamp === self::DEPRECATED_USAGE_TIMESTAMP ) {
118  // wfDeprecated( __METHOD__, '1.27' );
119  if ( $this->checkRights && !$this->user->isAllowed( 'viewmywatchlist' ) ) {
120  return false;
121  }
122  $item = MediaWikiServices::getInstance()->getWatchedItemStore()
123  ->loadWatchedItem( $this->user, $this->linkTarget );
124  if ( $item ) {
125  $this->notificationTimestamp = $item->getNotificationTimestamp();
126  } else {
127  $this->notificationTimestamp = false;
128  }
129  }
131  }
132 
143  public function getTitle() {
144  if ( !$this->title ) {
145  $this->title = Title::newFromLinkTarget( $this->linkTarget );
146  }
147  return $this->title;
148  }
149 
155  wfDeprecated( __METHOD__, '1.27' );
156  return new self( $user, $title, self::DEPRECATED_USAGE_TIMESTAMP, (bool)$checkRights );
157  }
158 
163  public function addWatch() {
164  wfDeprecated( __METHOD__, '1.27' );
165  $this->user->addWatch( $this->getTitle(), $this->checkRights );
166  return true;
167  }
168 
173  public function removeWatch() {
174  wfDeprecated( __METHOD__, '1.27' );
175  if ( $this->checkRights && !$this->user->isAllowed( 'editmywatchlist' ) ) {
176  return false;
177  }
178  $this->user->removeWatch( $this->getTitle(), $this->checkRights );
179  return true;
180  }
181 
186  public function isWatched() {
187  wfDeprecated( __METHOD__, '1.27' );
188  return $this->user->isWatched( $this->getTitle(), $this->checkRights );
189  }
190 
194  public static function duplicateEntries( Title $oldTitle, Title $newTitle ) {
195  wfDeprecated( __METHOD__, '1.27' );
196  $store = MediaWikiServices::getInstance()->getWatchedItemStore();
197  $store->duplicateAllAssociatedEntries( $oldTitle, $newTitle );
198  }
199 
200 }
WatchedItem\$notificationTimestamp
null string $notificationTimestamp
the value of the wl_notificationtimestamp field
Definition: WatchedItem.php:74
WatchedItem\$checkRights
bool $checkRights
Definition: WatchedItem.php:53
WatchedItem\isWatched
isWatched()
Definition: WatchedItem.php:186
WatchedItem\$user
User $user
Definition: WatchedItem.php:69
WatchedItem\DEPRECATED_USAGE_TIMESTAMP
const DEPRECATED_USAGE_TIMESTAMP
Definition: WatchedItem.php:47
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
WatchedItem\removeWatch
removeWatch()
Definition: WatchedItem.php:173
WatchedItem\getTitle
getTitle()
Back compat pre 1.27 with the WatchedItemStore introduction.
Definition: WatchedItem.php:143
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
user
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Definition: distributors.txt:9
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1128
WatchedItem\$title
Title $title
Definition: WatchedItem.php:59
Title\newFromLinkTarget
static newFromLinkTarget(LinkTarget $linkTarget)
Create a new Title from a LinkTarget.
Definition: Title.php:239
WatchedItem\IGNORE_USER_RIGHTS
const IGNORE_USER_RIGHTS
Definition: WatchedItem.php:37
$oldTitle
versus $oldTitle
Definition: globals.txt:16
User\CHECK_USER_RIGHTS
const CHECK_USER_RIGHTS
Definition: User.php:82
WatchedItem\duplicateEntries
static duplicateEntries(Title $oldTitle, Title $newTitle)
Definition: WatchedItem.php:194
WatchedItem\getUser
getUser()
Definition: WatchedItem.php:99
title
title
Definition: parserTests.txt:211
WatchedItem
Representation of a pair of user and title for watchlist entries.
Definition: WatchedItem.php:32
WatchedItem\CHECK_USER_RIGHTS
const CHECK_USER_RIGHTS
Definition: WatchedItem.php:42
Title
Represents a title within MediaWiki.
Definition: Title.php:39
WatchedItem\fromUserTitle
static fromUserTitle( $user, $title, $checkRights=User::CHECK_USER_RIGHTS)
Definition: WatchedItem.php:154
WatchedItem\getLinkTarget
getLinkTarget()
Definition: WatchedItem.php:106
WatchedItem\addWatch
addWatch()
Definition: WatchedItem.php:163
WatchedItem\__construct
__construct(User $user, LinkTarget $linkTarget, $notificationTimestamp, $checkRights=null)
Definition: WatchedItem.php:82
WatchedItem\getNotificationTimestamp
getNotificationTimestamp()
Get the notification timestamp of this entry.
Definition: WatchedItem.php:115
User\IGNORE_USER_RIGHTS
const IGNORE_USER_RIGHTS
Definition: User.php:87
MediaWikiServices
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
MediaWiki\Linker\LinkTarget
Definition: LinkTarget.php:27
WatchedItem\$linkTarget
LinkTarget $linkTarget
Definition: WatchedItem.php:64
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:50