Collaboration diagram for WatchedItemQueryService:

[legend]

Public Member Functions
	__construct (ILoadBalancer $loadBalancer, CommentStore $commentStore, ActorMigration $actorMigration, WatchedItemStoreInterface $watchedItemStore, PermissionManager $permissionManager, HookContainer $hookContainer, bool $expiryEnabled=false, int $maxQueryExecutionTime=0)

	getWatchedItemsForUser (UserIdentity $user, array $options=[])
	For simple listing of user's watchlist items, see WatchedItemStore::getWatchedItemsForUser.

	getWatchedItemsWithRecentChangeInfo (User $user, array $options=[], &$startFrom=null)

Public Attributes
const	DIR_NEWER = 'newer'

const	DIR_OLDER = 'older'

const	FILTER_ANON = 'anon'

const	FILTER_AUTOPATROLLED = 'autopatrolled'

const	FILTER_BOT = 'bot'

const	FILTER_CHANGED = 'changed'

const	FILTER_MINOR = 'minor'

const	FILTER_NOT_ANON = '!anon'

const	FILTER_NOT_AUTOPATROLLED = '!autopatrolled'

const	FILTER_NOT_BOT = '!bot'

const	FILTER_NOT_CHANGED = '!changed'

const	FILTER_NOT_MINOR = '!minor'

const	FILTER_NOT_PATROLLED = '!patrolled'

const	FILTER_NOT_UNREAD = '!unread'

const	FILTER_PATROLLED = 'patrolled'

const	FILTER_UNREAD = 'unread'

const	INCLUDE_AUTOPATROL_INFO = 'autopatrol'

const	INCLUDE_COMMENT = 'comment'

const	INCLUDE_FLAGS = 'flags'

const	INCLUDE_LOG_INFO = 'loginfo'

const	INCLUDE_PATROL_INFO = 'patrol'

const	INCLUDE_SIZES = 'sizes'

const	INCLUDE_TAGS = 'tags'

const	INCLUDE_USER = 'user'

const	INCLUDE_USER_ID = 'userid'

const	SORT_ASC = 'ASC'

const	SORT_DESC = 'DESC'

Private Member Functions
	getConnection ()

	getExtensions ()

	getExtraDeletedPageLogEntryRelatedCond (IDatabase $db, UserIdentity $user)

	getFromUntilTargetConds (IDatabase $db, LinkTarget $target, $op)
	Creates a query condition part for getting only items before or after the given link target (while ordering using $sort mode)

	getRecentChangeFieldsFromRow (stdClass $row)

	getStartEndConds (IDatabase $db, array $options)

	getStartFromConds (IDatabase $db, array $options, array $startFrom)

	getUserRelatedConds (IDatabase $db, UserIdentity $user, array $options)

	getWatchedItemsForUserQueryConds (IDatabase $db, UserIdentity $user, array $options)

	getWatchedItemsForUserQueryDbOptions (array $options)

	getWatchedItemsWithRCInfoQueryConds (IDatabase $db, User $user, array $options)

	getWatchedItemsWithRCInfoQueryDbOptions (array $options)

	getWatchedItemsWithRCInfoQueryFields (array $options)

	getWatchedItemsWithRCInfoQueryFilterConds (User $user, array $options)

	getWatchedItemsWithRCInfoQueryJoinConds (array $options)

	getWatchedItemsWithRCInfoQueryTables (array $options)

	getWatchlistOwnerId (UserIdentity $user, array $options)

Private Attributes
ActorMigration	$actorMigration

CommentStore	$commentStore

bool	$expiryEnabled
	Correlates to $wgWatchlistExpiry feature flag.

WatchedItemQueryServiceExtension[] null	$extensions = null

HookRunner	$hookRunner

ILoadBalancer	$loadBalancer

int	$maxQueryExecutionTime
	Max query execution time.

PermissionManager	$permissionManager

WatchedItemStoreInterface	$watchedItemStore

Detailed Description

Definition at line 23 of file WatchedItemQueryService.php.

Constructor & Destructor Documentation

◆ __construct()

WatchedItemQueryService::__construct	(	ILoadBalancer	$loadBalancer,
		CommentStore	$commentStore,
		ActorMigration	$actorMigration,
		WatchedItemStoreInterface	$watchedItemStore,
		PermissionManager	$permissionManager,
		HookContainer	$hookContainer,
		bool	$expiryEnabled = `false`,
		int	$maxQueryExecutionTime = `0`
	)

Definition at line 92 of file WatchedItemQueryService.php.

Member Function Documentation

◆ getConnection()

WatchedItemQueryService::getConnection ( )

private

Returns: IDatabase

Definition at line 126 of file WatchedItemQueryService.php.

References DB_REPLICA.

Referenced by getWatchedItemsForUser(), and getWatchedItemsWithRecentChangeInfo().

◆ getExtensions()

WatchedItemQueryService::getExtensions ( )

private

Returns: WatchedItemQueryServiceExtension[]

Definition at line 115 of file WatchedItemQueryService.php.

Referenced by getWatchedItemsWithRecentChangeInfo().

◆ getExtraDeletedPageLogEntryRelatedCond()

WatchedItemQueryService::getExtraDeletedPageLogEntryRelatedCond	(	IDatabase	$db,
		UserIdentity	$user
	)

private

Definition at line 635 of file WatchedItemQueryService.php.

References Wikimedia\Rdbms\IDatabase\bitAnd(), LogPage\DELETED_ACTION, LogPage\DELETED_RESTRICTED, LIST_OR, Wikimedia\Rdbms\IDatabase\makeList(), and RC_LOG.

Referenced by getWatchedItemsWithRCInfoQueryConds().

◆ getFromUntilTargetConds()

WatchedItemQueryService::getFromUntilTargetConds	(	IDatabase	$db,
		LinkTarget	$target,
			$op
	)

private

Creates a query condition part for getting only items before or after the given link target (while ordering using $sort mode)

Parameters

IDatabase	$db
LinkTarget	$target
string	$op	comparison operator to use in the conditions

Returns: string

Definition at line 716 of file WatchedItemQueryService.php.

References Wikimedia\Rdbms\IDatabase\addQuotes(), MediaWiki\Linker\LinkTarget\getDBkey(), MediaWiki\Linker\LinkTarget\getNamespace(), LIST_AND, LIST_OR, and Wikimedia\Rdbms\IDatabase\makeList().

Referenced by getWatchedItemsForUserQueryConds().

◆ getRecentChangeFieldsFromRow()

WatchedItemQueryService::getRecentChangeFieldsFromRow ( stdClass $row )

private

Definition at line 373 of file WatchedItemQueryService.php.

Referenced by getWatchedItemsWithRecentChangeInfo().

◆ getStartEndConds()

WatchedItemQueryService::getStartEndConds	(	IDatabase	$db,
		array	$options
	)

private

Definition at line 583 of file WatchedItemQueryService.php.

References Wikimedia\Rdbms\IDatabase\addQuotes(), and Wikimedia\Rdbms\IDatabase\timestamp().

Referenced by getWatchedItemsWithRCInfoQueryConds().

◆ getStartFromConds()

WatchedItemQueryService::getStartFromConds	(	IDatabase	$db,
		array	$options,
		array	$startFrom
	)

private

Definition at line 655 of file WatchedItemQueryService.php.

References Wikimedia\Rdbms\IDatabase\addQuotes(), LIST_AND, LIST_OR, Wikimedia\Rdbms\IDatabase\makeList(), and Wikimedia\Rdbms\IDatabase\timestamp().

Referenced by getWatchedItemsWithRecentChangeInfo().

◆ getUserRelatedConds()

WatchedItemQueryService::getUserRelatedConds	(	IDatabase	$db,
		UserIdentity	$user,
		array	$options
	)

private

Definition at line 604 of file WatchedItemQueryService.php.

References Wikimedia\Rdbms\IDatabase\bitAnd(), and User\newFromName().

Referenced by getWatchedItemsWithRCInfoQueryConds().

◆ getWatchedItemsForUser()

WatchedItemQueryService::getWatchedItemsForUser	(	UserIdentity	$user,
		array	$options = `[]`
	)

For simple listing of user's watchlist items, see WatchedItemStore::getWatchedItemsForUser.

Parameters

UserIdentity	$user
array	$options	Allowed keys: 'sort' => string optional sorting by namespace ID and title one of the self::SORT_* constants 'namespaceIds' => int[] optional namespace IDs to filter by (defaults to all namespaces) 'limit' => int maximum number of items to return 'filter' => string optional filter, one of the self::FILTER_* contants 'from' => LinkTarget requires 'sort' key, only return items starting from those related to the link target 'until' => LinkTarget requires 'sort' key, only return items until those related to the link target 'startFrom' => LinkTarget requires 'sort' key, only return items starting from those related to the link target, allows to skip some link targets specified using the form option

Returns: WatchedItem[]

Definition at line 304 of file WatchedItemQueryService.php.

References $res, getConnection(), getWatchedItemsForUserQueryConds(), getWatchedItemsForUserQueryDbOptions(), and MediaWiki\User\UserIdentity\isRegistered().

◆ getWatchedItemsForUserQueryConds()

WatchedItemQueryService::getWatchedItemsForUserQueryConds	(	IDatabase	$db,
		UserIdentity	$user,
		array	$options
	)

private

Definition at line 675 of file WatchedItemQueryService.php.

References getFromUntilTargetConds(), and MediaWiki\User\UserIdentity\getId().

Referenced by getWatchedItemsForUser().

◆ getWatchedItemsForUserQueryDbOptions()

WatchedItemQueryService::getWatchedItemsForUserQueryDbOptions ( array $options )

private

Definition at line 749 of file WatchedItemQueryService.php.

Referenced by getWatchedItemsForUser().

◆ getWatchedItemsWithRCInfoQueryConds()

WatchedItemQueryService::getWatchedItemsWithRCInfoQueryConds	(	IDatabase	$db,
		User	$user,
		array	$options
	)

private

Definition at line 468 of file WatchedItemQueryService.php.

References Wikimedia\Rdbms\IDatabase\addQuotes(), getExtraDeletedPageLogEntryRelatedCond(), getStartEndConds(), Wikimedia\Rdbms\IDatabase\getType(), getUserRelatedConds(), getWatchedItemsWithRCInfoQueryFilterConds(), getWatchlistOwnerId(), LIST_OR, Wikimedia\Rdbms\IDatabase\makeList(), RC_LOG, and Wikimedia\Rdbms\IDatabase\timestamp().

Referenced by getWatchedItemsWithRecentChangeInfo().

◆ getWatchedItemsWithRCInfoQueryDbOptions()

WatchedItemQueryService::getWatchedItemsWithRCInfoQueryDbOptions ( array $options )

private

Definition at line 732 of file WatchedItemQueryService.php.

Referenced by getWatchedItemsWithRecentChangeInfo().

◆ getWatchedItemsWithRCInfoQueryFields()

WatchedItemQueryService::getWatchedItemsWithRCInfoQueryFields ( array $options )

private

Definition at line 410 of file WatchedItemQueryService.php.

References ChangeTags\makeTagSummarySubquery().

Referenced by getWatchedItemsWithRecentChangeInfo().

◆ getWatchedItemsWithRCInfoQueryFilterConds()

WatchedItemQueryService::getWatchedItemsWithRCInfoQueryFilterConds	(	User	$user,
		array	$options
	)

private

Definition at line 532 of file WatchedItemQueryService.php.

References User\useNPPatrol(), and User\useRCPatrol().

Referenced by getWatchedItemsWithRCInfoQueryConds().

◆ getWatchedItemsWithRCInfoQueryJoinConds()

WatchedItemQueryService::getWatchedItemsWithRCInfoQueryJoinConds ( array $options )

private

Definition at line 769 of file WatchedItemQueryService.php.

Referenced by getWatchedItemsWithRecentChangeInfo().

◆ getWatchedItemsWithRCInfoQueryTables()

WatchedItemQueryService::getWatchedItemsWithRCInfoQueryTables ( array $options )

private

Definition at line 386 of file WatchedItemQueryService.php.

Referenced by getWatchedItemsWithRecentChangeInfo().

◆ getWatchedItemsWithRecentChangeInfo()

WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo	(	User	$user,
		array	$options = `[]`,
		&	$startFrom = `null`
	)

Parameters

User	$user
array	$options	Allowed keys: 'includeFields' => string[] RecentChange fields to be included in the result, self::INCLUDE_* constants should be used 'filters' => string[] optional filters to narrow down resulted items 'namespaceIds' => int[] optional namespace IDs to filter by (defaults to all namespaces) 'allRevisions' => bool return multiple revisions of the same page if true, only the most recent if false (default) 'rcTypes' => int[] which types of RecentChanges to include (defaults to all types), allowed values: RC_EDIT, RC_NEW, RC_LOG, RC_EXTERNAL, RC_CATEGORIZE 'onlyByUser' => string only list changes by a specified user 'notByUser' => string do not incluide changes by a specified user 'dir' => string in which direction to enumerate, accepted values: DIR_OLDER list newest first DIR_NEWER list oldest first 'start' => string (format accepted by wfTimestamp) requires 'dir' option, timestamp to start enumerating from 'end' => string (format accepted by wfTimestamp) requires 'dir' option, timestamp to end enumerating 'watchlistOwner' => User user whose watchlist items should be listed if different than the one specified with $user param, requires 'watchlistOwnerToken' option 'watchlistOwnerToken' => string a watchlist token used to access another user's watchlist, used with 'watchlistOwnerToken' option 'limit' => int maximum numbers of items to return 'usedInGenerator' => bool include only RecentChange id field required by the generator ('rc_cur_id' or 'rc_this_oldid') if true, or all id fields ('rc_cur_id', 'rc_this_oldid', 'rc_last_oldid') if false (default)
array \| null	&$startFrom	Continuation value: [ string $rcTimestamp, int $rcId ]