WatchedItem::isWatched() - Code Metrics - Inspection of "Daily Inspection: Merge "Adding support for numeri..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (420c52)

unknown

created 2016-07-27 17:20 UTC

WatchedItem::isWatched() A

↳ Parent: WatchedItem

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	4
rs	10
c	1
b	0
f	0

<?php
/**
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup Watchlist
 */
use MediaWiki\MediaWikiServices;
use MediaWiki\Linker\LinkTarget;

/**
 * Representation of a pair of user and title for watchlist entries.
 *
 * @author Tim Starling
 * @author Addshore
 *
 * @ingroup Watchlist
 */
class WatchedItem {

	/**
	 * @deprecated since 1.27, see User::IGNORE_USER_RIGHTS
	 */
	const IGNORE_USER_RIGHTS = User::IGNORE_USER_RIGHTS;

	/**
	 * @deprecated since 1.27, see User::CHECK_USER_RIGHTS
	 */
	const CHECK_USER_RIGHTS = User::CHECK_USER_RIGHTS;

	/**
	 * @deprecated Internal class use only
	 */
	const DEPRECATED_USAGE_TIMESTAMP = -100;

	/**
	 * @var bool
	 * @deprecated Internal class use only
	 */
	public $checkRights = User::CHECK_USER_RIGHTS;

	/**
	 * @var Title
	 * @deprecated Internal class use only
	 */
	private $title;

	/**
	 * @var LinkTarget
	 */
	private $linkTarget;

	/**
	 * @var User
	 */
	private $user;

	/**
	 * @var null|string the value of the wl_notificationtimestamp field
	 */
	private $notificationTimestamp;

	/**
	 * @param User $user
	 * @param LinkTarget $linkTarget
	 * @param null|string $notificationTimestamp the value of the wl_notificationtimestamp field
	 * @param bool|null $checkRights DO NOT USE - used internally for backward compatibility
	 */
	public function __construct(
		User $user,
		LinkTarget $linkTarget,
		$notificationTimestamp,
		$checkRights = null
	) {
		$this->user = $user;
		$this->linkTarget = $linkTarget;
		$this->notificationTimestamp = $notificationTimestamp;
		if ( $checkRights !== null ) {
			$this->checkRights = $checkRights;

		}
	}

	/**
	 * @return User
	 */
	public function getUser() {
		return $this->user;
	}

	/**
	 * @return LinkTarget
	 */
	public function getLinkTarget() {
		return $this->linkTarget;
	}

	/**
	 * Get the notification timestamp of this entry.
	 *
	 * @return bool|null|string
	 */
	public function getNotificationTimestamp() {
		// Back compat for objects constructed using self::fromUserTitle
		if ( $this->notificationTimestamp === self::DEPRECATED_USAGE_TIMESTAMP ) {

			// wfDeprecated( __METHOD__, '1.27' );
			if ( $this->checkRights && !$this->user->isAllowed( 'viewmywatchlist' ) ) {

				return false;
			}
			$item = MediaWikiServices::getInstance()->getWatchedItemStore()
				->loadWatchedItem( $this->user, $this->linkTarget );
			if ( $item ) {
				$this->notificationTimestamp = $item->getNotificationTimestamp();
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
			} else {
				$this->notificationTimestamp = false;

			}
		}
		return $this->notificationTimestamp;
	}

	/**
	 * Back compat pre 1.27 with the WatchedItemStore introduction
	 * @todo remove in 1.28/9
	 * -------------------------------------------------
	 */

	/**
	 * @return Title
	 * @deprecated Internal class use only
	 */
	public function getTitle() {
		if ( !$this->title ) {

			$this->title = Title::newFromLinkTarget( $this->linkTarget );

		}
		return $this->title;

	}

	/**
	 * @deprecated since 1.27 Use the constructor, WatchedItemStore::getWatchedItem()
	 *             or WatchedItemStore::loadWatchedItem()
	 */
	public static function fromUserTitle( $user, $title, $checkRights = User::CHECK_USER_RIGHTS ) {
		wfDeprecated( __METHOD__, '1.27' );
		return new self( $user, $title, self::DEPRECATED_USAGE_TIMESTAMP, (bool)$checkRights );

	}

	/**
	 * @deprecated since 1.27 Use User::addWatch()
	 * @return bool
	 */
	public function addWatch() {
		wfDeprecated( __METHOD__, '1.27' );
		$this->user->addWatch( $this->getTitle(), $this->checkRights );

		return true;
	}

	/**
	 * @deprecated since 1.27 Use User::removeWatch()
	 * @return bool
	 */
	public function removeWatch() {
		wfDeprecated( __METHOD__, '1.27' );
		if ( $this->checkRights && !$this->user->isAllowed( 'editmywatchlist' ) ) {

			return false;
		}
		$this->user->removeWatch( $this->getTitle(), $this->checkRights );

		return true;
	}

	/**
	 * @deprecated since 1.27 Use User::isWatched()
	 * @return bool
	 */
	public function isWatched() {
		wfDeprecated( __METHOD__, '1.27' );
		return $this->user->isWatched( $this->getTitle(), $this->checkRights );

	}

	/**
	 * @deprecated since 1.27 Use WatchedItemStore::duplicateAllAssociatedEntries()
	 */
	public static function duplicateEntries( Title $oldTitle, Title $newTitle ) {
		wfDeprecated( __METHOD__, '1.27' );
		$store = MediaWikiServices::getInstance()->getWatchedItemStore();
		$store->duplicateAllAssociatedEntries( $oldTitle, $newTitle );
	}

}


1			<?php
2			/**
3			* This program is free software; you can redistribute it and/or modify
4			* it under the terms of the GNU General Public License as published by
5			* the Free Software Foundation; either version 2 of the License, or
6			* (at your option) any later version.
7			*
8			* This program is distributed in the hope that it will be useful,
9			* but WITHOUT ANY WARRANTY; without even the implied warranty of
10			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11			* GNU General Public License for more details.
12			*
13			* You should have received a copy of the GNU General Public License along
14			* with this program; if not, write to the Free Software Foundation, Inc.,
15			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16			* http://www.gnu.org/copyleft/gpl.html
17			*
18			* @file
19			* @ingroup Watchlist
20			*/
21			use MediaWiki\MediaWikiServices;
22			use MediaWiki\Linker\LinkTarget;
23
24			/**
25			* Representation of a pair of user and title for watchlist entries.
26			*
27			* @author Tim Starling
28			* @author Addshore
29			*
30			* @ingroup Watchlist
31			*/
32			class WatchedItem {
33
34			/**
35			* @deprecated since 1.27, see User::IGNORE_USER_RIGHTS
36			*/
37			const IGNORE_USER_RIGHTS = User::IGNORE_USER_RIGHTS;
38
39			/**
40			* @deprecated since 1.27, see User::CHECK_USER_RIGHTS
41			*/
42			const CHECK_USER_RIGHTS = User::CHECK_USER_RIGHTS;
43
44			/**
45			* @deprecated Internal class use only
46			*/
47			const DEPRECATED_USAGE_TIMESTAMP = -100;
48
49			/**
50			* @var bool
51			* @deprecated Internal class use only
52			*/
53			public $checkRights = User::CHECK_USER_RIGHTS;
54
55			/**
56			* @var Title
57			* @deprecated Internal class use only
58			*/
59			private $title;
60
61			/**
62			* @var LinkTarget
63			*/
64			private $linkTarget;
65
66			/**
67			* @var User
68			*/
69			private $user;
70
71			/**
72			* @var null\|string the value of the wl_notificationtimestamp field
73			*/
74			private $notificationTimestamp;
75
76			/**
77			* @param User $user
78			* @param LinkTarget $linkTarget
79			* @param null\|string $notificationTimestamp the value of the wl_notificationtimestamp field
80			* @param bool\|null $checkRights DO NOT USE - used internally for backward compatibility
81			*/
82			public function __construct(
83			User $user,
84			LinkTarget $linkTarget,
85			$notificationTimestamp,
86			$checkRights = null
87			) {
88			$this->user = $user;
89			$this->linkTarget = $linkTarget;
90			$this->notificationTimestamp = $notificationTimestamp;
91			if ( $checkRights !== null ) {
92			$this->checkRights = $checkRights;
			0 ignored issues – show Deprecated Code introduced 2016-03-09 18:21 UTC by Report Bug Copy Issue Report The property `WatchedItem::$checkRights` has been deprecated with message: Internal class use only This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
93			}
94			}
95
96			/**
97			* @return User
98			*/
99			public function getUser() {
100			return $this->user;
101			}
102
103			/**
104			* @return LinkTarget
105			*/
106			public function getLinkTarget() {
107			return $this->linkTarget;
108			}
109
110			/**
111			* Get the notification timestamp of this entry.
112			*
113			* @return bool\|null\|string
114			*/
115			public function getNotificationTimestamp() {
116			// Back compat for objects constructed using self::fromUserTitle
117			if ( $this->notificationTimestamp === self::DEPRECATED_USAGE_TIMESTAMP ) {
			0 ignored issues – show Deprecated Code introduced 2016-03-09 18:21 UTC by Report Bug Copy Issue Report The constant `WatchedItem::DEPRECATED_USAGE_TIMESTAMP` has been deprecated with message: Internal class use only This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
118			// wfDeprecated( __METHOD__, '1.27' );
119			if ( $this->checkRights && !$this->user->isAllowed( 'viewmywatchlist' ) ) {
			0 ignored issues – show Deprecated Code introduced 2016-03-09 18:21 UTC by Report Bug Copy Issue Report The property `WatchedItem::$checkRights` has been deprecated with message: Internal class use only This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
120			return false;
121			}
122			$item = MediaWikiServices::getInstance()->getWatchedItemStore()
123			->loadWatchedItem( $this->user, $this->linkTarget );
124			if ( $item ) {
125			$this->notificationTimestamp = $item->getNotificationTimestamp();
			0 ignored issues – show Documentation Bug introduced 2016-03-09 18:21 UTC by Report Bug Copy Issue Report It seems like `$item->getNotificationTimestamp()` can also be of type `boolean`. However, the property `$notificationTimestamp` is declared as type `null\|string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
126			} else {
127			$this->notificationTimestamp = false;
			0 ignored issues – show Documentation Bug introduced 2016-03-09 18:21 UTC by Report Bug Copy Issue Report It seems like `false` of type `false` is incompatible with the declared type `null\|string` of property `$notificationTimestamp`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
128			}
129			}
130			return $this->notificationTimestamp;
131			}
132
133			/**
134			* Back compat pre 1.27 with the WatchedItemStore introduction
135			* @todo remove in 1.28/9
136			* -------------------------------------------------
137			*/
138
139			/**
140			* @return Title
141			* @deprecated Internal class use only
142			*/
143			public function getTitle() {
144			if ( !$this->title ) {
			0 ignored issues – show Deprecated Code introduced 2016-03-09 18:21 UTC by Report Bug Copy Issue Report The property `WatchedItem::$title` has been deprecated with message: Internal class use only This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
145			$this->title = Title::newFromLinkTarget( $this->linkTarget );
			0 ignored issues – show Deprecated Code introduced 2016-03-09 18:21 UTC by Report Bug Copy Issue Report The property `WatchedItem::$title` has been deprecated with message: Internal class use only This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
146			}
147			return $this->title;
			0 ignored issues – show Deprecated Code introduced 2016-03-09 18:21 UTC by Report Bug Copy Issue Report The property `WatchedItem::$title` has been deprecated with message: Internal class use only This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
148			}
149
150			/**
151			* @deprecated since 1.27 Use the constructor, WatchedItemStore::getWatchedItem()
152			* or WatchedItemStore::loadWatchedItem()
153			*/
154			public static function fromUserTitle( $user, $title, $checkRights = User::CHECK_USER_RIGHTS ) {
155			wfDeprecated( __METHOD__, '1.27' );
156			return new self( $user, $title, self::DEPRECATED_USAGE_TIMESTAMP, (bool)$checkRights );
			0 ignored issues – show Deprecated Code introduced 2016-03-09 18:21 UTC by Report Bug Copy Issue Report The constant `WatchedItem::DEPRECATED_USAGE_TIMESTAMP` has been deprecated with message: Internal class use only This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
157			}
158
159			/**
160			* @deprecated since 1.27 Use User::addWatch()
161			* @return bool
162			*/
163			public function addWatch() {
164			wfDeprecated( __METHOD__, '1.27' );
165			$this->user->addWatch( $this->getTitle(), $this->checkRights );
			0 ignored issues – show Deprecated Code introduced 2016-03-09 18:21 UTC by Report Bug Copy Issue Report The property `WatchedItem::$checkRights` has been deprecated with message: Internal class use only This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
166			return true;
167			}
168
169			/**
170			* @deprecated since 1.27 Use User::removeWatch()
171			* @return bool
172			*/
173			public function removeWatch() {
174			wfDeprecated( __METHOD__, '1.27' );
175			if ( $this->checkRights && !$this->user->isAllowed( 'editmywatchlist' ) ) {
			0 ignored issues – show Deprecated Code introduced 2016-03-09 18:21 UTC by Report Bug Copy Issue Report The property `WatchedItem::$checkRights` has been deprecated with message: Internal class use only This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
176			return false;
177			}
178			$this->user->removeWatch( $this->getTitle(), $this->checkRights );
			0 ignored issues – show Deprecated Code introduced 2016-03-09 18:21 UTC by Report Bug Copy Issue Report The property `WatchedItem::$checkRights` has been deprecated with message: Internal class use only This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
179			return true;
180			}
181
182			/**
183			* @deprecated since 1.27 Use User::isWatched()
184			* @return bool
185			*/
186			public function isWatched() {
187			wfDeprecated( __METHOD__, '1.27' );
188			return $this->user->isWatched( $this->getTitle(), $this->checkRights );
			0 ignored issues – show Deprecated Code introduced 2016-03-09 18:21 UTC by Report Bug Copy Issue Report The property `WatchedItem::$checkRights` has been deprecated with message: Internal class use only This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
189			}
190
191			/**
192			* @deprecated since 1.27 Use WatchedItemStore::duplicateAllAssociatedEntries()
193			*/
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			}
201

wikimedia / mediawiki

Branch — master (420c52)

WatchedItem::isWatched() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like