1fc8d79ac6
For example, documenting the method getUser() with "get the User object" does not add any information that's not already there. But I have to read the text first to understand that it doesn't document anything that's not already obvious from the code. Some of this is from a time when we had a PHPCS sniff that was complaining when a line like `@param User $user` doesn't end with some descriptive text. Some users started adding text like `@param User $user The User` back then. Let's please remove this. Change-Id: I0ea8d051bc732466c73940de9259f87ffb86ce7a
32 lines
1.1 KiB
PHP
32 lines
1.1 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Cache\Hook;
|
|
|
|
use Title;
|
|
|
|
/**
|
|
* This is a hook handler interface, see docs/Hooks.md.
|
|
* Use the hook name "HtmlCacheUpdaterAppendUrls" to register handlers implementing this interface.
|
|
*
|
|
* @stable to implement
|
|
* @ingroup Hooks
|
|
*/
|
|
interface HtmlCacheUpdaterAppendUrlsHook {
|
|
/**
|
|
* This hook is used to declare extra URLs to purge from HTTP caches.
|
|
*
|
|
* Use $mode to decide whether to gather all related URLs or only those affected by a
|
|
* re-render of the same content. For example, after a direct revision to the content the
|
|
* history page will need to be purged. However when re-rendering after a cascading change
|
|
* from a template, only URLs that render content need purging. The $mode will be either
|
|
* HtmlCacheUpdater::PURGE_URLS_LINKSUPDATE_ONLY or 0.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param Title $title Title of the page being updated
|
|
* @param int $mode
|
|
* @param array &$append Append URLs relating to the title
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onHtmlCacheUpdaterAppendUrls( $title, $mode, &$append );
|
|
}
|