Edited doc comments for hook interfaces to improve consistency and add type hints. Bug: T246855 Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
27 lines
770 B
PHP
27 lines
770 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Diff\Hook;
|
|
|
|
use DifferenceEngine;
|
|
|
|
/**
|
|
* @stable for implementation
|
|
* @ingroup Hooks
|
|
*/
|
|
interface DifferenceEngineMarkPatrolledLinkHook {
|
|
/**
|
|
* Use this hook to change the "mark as patrolled" link which is shown both
|
|
* on the diff header as well as on the bottom of a page, usually wrapped in
|
|
* a span element which has class="patrollink".
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param DifferenceEngine $differenceEngine
|
|
* @param string &$markAsPatrolledLink "Mark as patrolled" link HTML
|
|
* @param int $rcid Recent change ID (rc_id) for this change
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onDifferenceEngineMarkPatrolledLink( $differenceEngine,
|
|
&$markAsPatrolledLink, $rcid
|
|
);
|
|
}
|