* @param string|int $key
* @param mixed $value
* @param mixed $default
- * @param array $changed Array to alter
+ * @param array &$changed Array to alter
* @throws MWException
*/
function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
* 1) Does not raise warnings on bad URLs (just returns false).
* 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
* protocol-relative URLs) correctly.
- * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2)).
+ * 3) Adds a "delimiter" element to the array (see (2)).
+ * 4) Verifies that the protocol is on the $wgUrlProtocols whitelist.
+ * 5) Rejects some invalid URLs that parse_url doesn't, e.g. the empty string or URLs starting with
+ * a line feed character.
*
* @param string $url A URL to parse
- * @return string[]|bool Bits of the URL in an associative array, per PHP docs, false on failure
+ * @return string[]|bool Bits of the URL in an associative array, or false on failure.
+ * Possible fields:
+ * - scheme: URI scheme (protocol), e.g. 'http', 'mailto'. Lowercase, always present, but can
+ * be an empty string for protocol-relative URLs.
+ * - delimiter: either '://', ':' or '//'. Always present.
+ * - host: domain name / IP. Always present, but could be an empty string, e.g. for file: URLs.
+ * - user: user name, e.g. for HTTP Basic auth URLs such as http://user:pass@example.com/
+ * Missing when there is no username.
+ * - pass: password, same as above.
+ * - path: path including the leading /. Will be missing when empty (e.g. 'http://example.com')
+ * - query: query string (as a string; see wfCgiToArray() for parsing it), can be missing.
+ * - fragment: the part after #, can be missing.
*/
function wfParseUrl( $url ) {
global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
* If source is NULL, it just returns the value, it doesn't set the variable
* If force is true, it will set the value even if source is NULL
*
- * @param mixed $dest
+ * @param mixed &$dest
* @param mixed $source
* @param bool $force
* @return mixed
/**
* As for wfSetVar except setting a bit
*
- * @param int $dest
+ * @param int &$dest
* @param int $bit
* @param bool $state
*
* (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
* PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
*
- * @param string ... strings to escape and glue together, or a single array of strings parameter
+ * @param string $args,... strings to escape and glue together,
+ * or a single array of strings parameter
* @return string
*/
function wfEscapeShellArg( /*...*/ ) {
* @param string $old
* @param string $mine
* @param string $yours
- * @param string $result
+ * @param string &$result
* @return bool
*/
function wfMerge( $old, $mine, $yours, &$result ) {
/**
* Get the cache object used by the parser cache
*
+ * @deprecated since 1.30, use MediaWikiServices::getParserCache()->getCacheStorage()
* @return BagOStuff
*/
function wfGetParserCacheStorage() {
* @since 1.25
*/
function wfIsInfinity( $str ) {
+ // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
$infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
return in_array( $str, $infinityValues );
}