From febf5f7a155c7013f29eea6e14d8e0202ba4b91e Mon Sep 17 00:00:00 2001 From: Umherirrender Date: Sat, 26 Jan 2019 13:51:09 +0100 Subject: [PATCH] Improve docs for Title::getInternalURL/getCanonicalURL Both calling fixUrlQueryArgs, which handle the array case Also improve hooks docs for the similar functions getLinkUrl/getLocalUrl Change-Id: I77df39711c7d6b2ee0a3709a6bdaf9cde6a616c6 --- docs/hooks.txt | 10 +++++----- includes/Title.php | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/hooks.txt b/docs/hooks.txt index d175bcdf82..031e6d74ea 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -1622,7 +1622,7 @@ $out: OutputPage object notifications. &$title: Title object of page &$url: string value as output (out parameter, can modify) -$query: query options passed to Title::getCanonicalURL() +$query: query options as string passed to Title::getCanonicalURL() 'GetContentModels': Add content models to the list of available models. &$models: array containing current model list, as strings. Extensions should add to this list. @@ -1660,7 +1660,7 @@ $single: Only extract the current language; if false, the prop value should 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data. &$title: Title object of page &$url: string value as output (out parameter, can modify) -$query: query options passed to Title::getFullURL() +$query: query options as string passed to Title::getFullURL() 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated by MWTimestamp::getHumanTimestamp(). Return false in this hook to use @@ -1674,7 +1674,7 @@ $lang: Language that will be used to render the timestamp 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging. &$title: Title object of page &$url: string value as output (out parameter, can modify) -$query: query options passed to Title::getInternalURL() +$query: query options as string passed to Title::getInternalURL() 'GetIP': modify the ip of the current user (called only once). &$ip: string holding the ip as determined so far @@ -1699,7 +1699,7 @@ be buggy for internal urls on render if you do not re-implement the horrible hack that Title::getLocalURL uses in your own extension. &$title: Title object of page &$url: string value as output (out parameter, can modify) -$query: query options passed to Title::getLocalURL() +$query: query options as string passed to Title::getLocalURL() 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths without any fancy queries or variants. @@ -1709,7 +1709,7 @@ without any fancy queries or variants. 'GetLocalURL::Internal': Modify local URLs to internal pages. &$title: Title object of page &$url: string value as output (out parameter, can modify) -$query: query options passed to Title::getLocalURL() +$query: query options as string passed to Title::getLocalURL() 'GetLogTypesOnUser': Add log types where the target is a userpage &$types: Array of log types diff --git a/includes/Title.php b/includes/Title.php index 6ada9b309d..057880c942 100644 --- a/includes/Title.php +++ b/includes/Title.php @@ -2104,8 +2104,8 @@ class Title implements LinkTarget, IDBAccessObject { * protocol-relative, the URL will be expanded to http:// * * @see self::getLocalURL for the arguments. - * @param string $query - * @param string|bool $query2 + * @param string|string[] $query + * @param string|bool $query2 Deprecated * @return string The URL */ public function getInternalURL( $query = '', $query2 = false ) { @@ -2127,8 +2127,8 @@ class Title implements LinkTarget, IDBAccessObject { * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment * * @see self::getLocalURL for the arguments. - * @param string $query - * @param string|bool $query2 + * @param string|string[] $query + * @param string|bool $query2 Deprecated * @return string The URL * @since 1.18 */ -- 2.20.1