wiki.techinc.nl/includes/Hook/FormatAutocommentsHook.php
James D. Forrester ad06527fb4 Reorg: Namespace the Title class
This is moderately messy.

Process was principally:

* xargs rg --files-with-matches '^use Title;' | grep 'php$' | \
  xargs -P 1 -n 1 sed -i -z 's/use Title;/use MediaWiki\\Title\\Title;/1'
* rg --files-without-match 'MediaWiki\\Title\\Title;' . | grep 'php$' | \
  xargs rg --files-with-matches 'Title\b' | \
  xargs -P 1 -n 1 sed -i -z 's/\nuse /\nuse MediaWiki\\Title\\Title;\nuse /1'
* composer fix

Then manual fix-ups for a few files that don't have any use statements.

Bug: T166010
Follows-Up: Ia5d8cb759dc3bc9e9bbe217d0fb109e2f8c4101a
Change-Id: If8fc9d0d95fc1a114021e282a706fc3e7da3524b
2023-03-02 08:46:53 -05:00

35 lines
1.3 KiB
PHP

<?php
namespace MediaWiki\Hook;
use MediaWiki\Title\Title;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "FormatAutocomments" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface FormatAutocommentsHook {
/**
* This hook is called when an autocomment is formatted by the Linker.
*
* @since 1.35
*
* @param string|null &$comment Reference to the accumulated comment.
* Initially null, when set the default code will be skipped.
* @param bool $pre True if there is text before this autocomment
* @param string $auto Extracted part of the parsed comment before the call to the hook
* @param bool $post True if there is text after this autocomment
* @param Title|null $title Optional title object used to links to sections
* @param bool $local Whether section links should refer to local page
* @param string|null $wikiId ID (as used by WikiMap) of the wiki from which the
* autocomment originated; null for the local wiki. Added in 1.26, should default
* to null in handler functions, for backwards compatibility.
* @return bool|void True or no return value to continue or false to abort
*/
public function onFormatAutocomments( &$comment, $pre, $auto, $post, $title,
$local, $wikiId
);
}