wiki.techinc.nl/includes/diff/Hook/DifferenceEngineMarkPatrolledRCIDHook.php
apaskulin c44488f725 docs: Hook interface doc comment review
Edited doc comments for hook interfaces to improve
consistency and add type hints.

Bug: T246855
Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
2020-04-21 09:10:08 +10:00

30 lines
810 B
PHP

<?php
namespace MediaWiki\Diff\Hook;
use DifferenceEngine;
use RecentChange;
use User;
/**
* @stable for implementation
* @ingroup Hooks
*/
interface DifferenceEngineMarkPatrolledRCIDHook {
/**
* Use this hook to possibly change the rcid parameter. For example the rcid
* might be set to zero due to the user being the same as the performer of
* the change but an extension might still want to show it under certain conditions.
*
* @since 1.35
*
* @param int &$rcid rc_id of the change or 0
* @param DifferenceEngine $differenceEngine
* @param RecentChange $change
* @param User $user Current user
* @return bool|void True or no return value to continue or false to abort
*/
public function onDifferenceEngineMarkPatrolledRCID( &$rcid, $differenceEngine,
$change, $user
);
}