wiki.techinc.nl/includes/diff/Hook/DifferenceEngineOldHeaderHook.php
Tim Starling f5aaf75ad1 Automatically generated hook interfaces
Add hook interfaces which were generated by a script which parses
hooks.txt and identifies caller namespaces and directories.

Hook interfaces are mostly placed in a Hook/ subdirectory
relative to the caller location. When there are callers in multiple
directories, a "primary" caller was manually selected. The exceptions to
this are:

* The source root, maintenance and tests, which use includes/Hook. Test
  hooks need to be autoloadable in a non-test request so that
  implementing test interfaces in a generic handler will not fail.
* resources uses includes/resourceloader/Hook
* The following third-level subdirectories had their hooks placed in
  the parent ../Hook:
    * includes/filerepo/file
    * includes/search/searchwidgets
    * includes/specials/forms
    * includes/specials/helpers
    * includes/specials/pagers

Parameters marked as legacy references in hooks.txt are passed
by value in the interfaces.

Bug: T240307
Change-Id: I6efe2e7dd1f0c6a3d0f4d100a4c34e41f8428720
2020-04-20 13:31:05 +10:00

35 lines
1.5 KiB
PHP

<?php
namespace MediaWiki\Diff\Hook;
/**
* @stable for implementation
* @ingroup Hooks
*/
interface DifferenceEngineOldHeaderHook {
/**
* Allows extensions to change the $oldHeader
* variable, which contains information about the old revision, such as the
* revision's author, whether the revision was marked as a minor edit or not, etc.
*
* @since 1.35
*
* @param ?mixed $differenceEngine DifferenceEngine object
* @param ?mixed &$oldHeader The string containing the various #mw-diff-otitle[1-5] divs, which
* include things like revision author info, revision comment, RevisionDelete
* link and more
* @param ?mixed $prevlink String containing the link to the previous revision (if any); also
* included in $oldHeader
* @param ?mixed $oldminor String indicating if the old revision was marked as a minor edit
* @param ?mixed $diffOnly Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
* whether we should show just the diff; passed in as a query string parameter to
* the various URLs constructed here (i.e. $prevlink)
* @param ?mixed $ldel RevisionDelete link for the old revision, if the current user is allowed
* to use the RevisionDelete feature
* @param ?mixed $unhide Boolean parameter indicating whether to show RevisionDeleted revisions
* @return bool|void True or no return value to continue or false to abort
*/
public function onDifferenceEngineOldHeader( $differenceEngine, &$oldHeader,
$prevlink, $oldminor, $diffOnly, $ldel, $unhide
);
}