/**
* Modify options in the login template.
*
- * @param BaseTemplate $template
- * @param string $type 'signup' or 'login'. Added in 1.16.
+ * @param BaseTemplate &$template
+ * @param string &$type 'signup' or 'login'. Added in 1.16.
*/
public function modifyUITemplate( &$template, &$type ) {
# Override this!
*
* @deprecated since 1.26, use the UserLoggedIn hook instead. And assigning
* a different User object to $user is no longer supported.
- * @param User $user
+ * @param User &$user
* @return bool
*/
public function updateUser( &$user ) {
*
* @deprecated since 1.26, use the UserLoggedIn hook instead. And assigning
* a different User object to $user is no longer supported.
- * @param User $user
+ * @param User &$user
* @param bool $autocreate True if user is being autocreated on login
*/
public function initUser( &$user, $autocreate = false ) {
/**
* Get an instance of a User object
*
- * @param User $user
+ * @param User &$user
*
* @return AuthPluginUser
*/
/**
* This function collects the form data and uses it to populate various member variables.
- * @param WebRequest $request
+ * @param WebRequest &$request
* @throws ErrorPageError
*/
public function importFormData( &$request ) {
* this method should be overridden and return the page text that will be used
* for saving, preview parsing and so on...
*
- * @param WebRequest $request
+ * @param WebRequest &$request
* @return string|null
*/
protected function importContentFormData( &$request ) {
/**
* Make sure the form isn't faking a user's credentials.
*
- * @param WebRequest $request
+ * @param WebRequest &$request
* @return bool
* @private
*/
/**
* Attempt submission
- * @param array|bool $resultDetails See docs for $result in internalAttemptSave
+ * @param array|bool &$resultDetails See docs for $result in internalAttemptSave
* @throws UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError
* @return Status The resulting status object.
*/
/**
* Attempt submission (no UI)
*
- * @param array $result Array to add statuses to, currently with the
+ * @param array &$result Array to add statuses to, currently with the
* possible keys:
* - spam (string): Spam string from content if any spam is detected by
* matchSpamRegex.
* Returns an array of html code of the following checkboxes old style:
* minor and watch
*
- * @param int $tabindex Current tabindex
+ * @param int &$tabindex Current tabindex
* @param array $checked See getCheckboxesDefinition()
* @return array
*/
* Returns an array of html code of the following checkboxes:
* minor and watch
*
- * @param int $tabindex Current tabindex
+ * @param int &$tabindex Current tabindex
* @param array $checked Array of checkbox => bool, where bool indicates the checked
* status of the checkbox
*
* Returns an array of html code of the following buttons:
* save, diff and preview
*
- * @param int $tabindex Current tabindex
+ * @param int &$tabindex Current tabindex
*
* @return array
*/
/**
* Really delete the file
*
- * @param Title $title
- * @param File $file
- * @param string $oldimage Archive name
+ * @param Title &$title
+ * @param File &$file
+ * @param string &$oldimage Archive name
* @param string $reason Reason of the deletion
* @param bool $suppress Whether to mark all deleted versions as restricted
* @param User $user User object performing the request
* value was provided, does it correspond to an
* existing, local, old version of this file?
*
- * @param File $file
- * @param File $oldfile
+ * @param File &$file
+ * @param File &$oldfile
* @param File $oldimage
* @return bool
*/
* @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 ) {
* 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
*
* @param string $old
* @param string $mine
* @param string $yours
- * @param string $result
+ * @param string &$result
* @return bool
*/
function wfMerge( $old, $mine, $yours, &$result ) {
}
/**
- * @param array $list
+ * @param array &$list
* @param array $path
* @param mixed $item
*/
/**
* @param Title $contextTitle
* @param string $target
- * @param string $text
+ * @param string &$text
* @return string
*/
public static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
* Returns true if the text matches the word, and alters the
* input string, removing all instances of the word
*
- * @param string $text
+ * @param string &$text
*
* @return bool
*/
}
/**
- * @param string $text
+ * @param string &$text
* @return bool
*/
public function matchStartAndRemove( &$text ) {
*
* @param array $magicarr
* @param string $subject
- * @param string $result
+ * @param string &$result
*
* @return bool
*/
* Adds all the synonyms of this MagicWord to an array, to allow quick
* lookup in a list of magic words
*
- * @param array $array
+ * @param array &$array
* @param string $value
*/
public function addToArray( &$array, $value ) {
* Returns an associative array, ID => param value, for all items that match
* Removes the matched items from the input string (passed by reference)
*
- * @param string $text
+ * @param string &$text
*
* @return array
*/
* Return false if no match found and $text is not modified.
* Does not match parameters.
*
- * @param string $text
+ * @param string &$text
*
* @return int|bool False on failure
*/
* Add wikitext with a custom Title object
*
* @param string $text Wikitext
- * @param Title $title
+ * @param Title &$title
* @param bool $linestart Is this the start of a line?
*/
public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
* Add wikitext with a custom Title object and tidy enabled.
*
* @param string $text Wikitext
- * @param Title $title
+ * @param Title &$title
* @param bool $linestart Is this the start of a line?
*/
function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
/**
* Add the output of a QuickTemplate to the output buffer
*
- * @param QuickTemplate $template
+ * @param QuickTemplate &$template
*/
public function addTemplate( &$template ) {
$this->addHTML( $template->getHTML() );
* @throws MWException
* @param User $user
* @param IContextSource $context
- * @param array $defaultPreferences Array to load values for
+ * @param array &$defaultPreferences Array to load values for
* @return array|null
*/
static function loadPreferenceValues( $user, $context, &$defaultPreferences ) {
/**
* @param User $user
* @param IContextSource $context
- * @param array $defaultPreferences
+ * @param array &$defaultPreferences
* @return void
*/
static function profilePreferences( $user, IContextSource $context, &$defaultPreferences ) {
/**
* @param User $user
* @param IContextSource $context
- * @param array $defaultPreferences
+ * @param array &$defaultPreferences
* @return void
*/
static function skinPreferences( $user, IContextSource $context, &$defaultPreferences ) {
/**
* @param User $user
* @param IContextSource $context
- * @param array $defaultPreferences
+ * @param array &$defaultPreferences
*/
static function filesPreferences( $user, IContextSource $context, &$defaultPreferences ) {
# # Files #####################################
/**
* @param User $user
* @param IContextSource $context
- * @param array $defaultPreferences
+ * @param array &$defaultPreferences
* @return void
*/
static function datetimePreferences( $user, IContextSource $context, &$defaultPreferences ) {
/**
* @param User $user
* @param IContextSource $context
- * @param array $defaultPreferences
+ * @param array &$defaultPreferences
*/
static function renderingPreferences( $user, IContextSource $context, &$defaultPreferences ) {
# # Diffs ####################################
/**
* @param User $user
* @param IContextSource $context
- * @param array $defaultPreferences
+ * @param array &$defaultPreferences
*/
static function editingPreferences( $user, IContextSource $context, &$defaultPreferences ) {
# # Editing #####################################
/**
* @param User $user
* @param IContextSource $context
- * @param array $defaultPreferences
+ * @param array &$defaultPreferences
*/
static function rcPreferences( $user, IContextSource $context, &$defaultPreferences ) {
$config = $context->getConfig();
/**
* @param User $user
* @param IContextSource $context
- * @param array $defaultPreferences
+ * @param array &$defaultPreferences
*/
static function watchlistPreferences( $user, IContextSource $context, &$defaultPreferences ) {
$config = $context->getConfig();
/**
* @param User $user
* @param IContextSource $context
- * @param array $defaultPreferences
+ * @param array &$defaultPreferences
*/
static function searchPreferences( $user, IContextSource $context, &$defaultPreferences ) {
foreach ( MWNamespace::getValidNamespaces() as $n ) {
/**
* Show protection long extracts for this page
*
- * @param OutputPage $out
+ * @param OutputPage &$out
* @access private
*/
function showLogExtract( &$out ) {
* data is compressed, and 'utf-8' if we're saving in UTF-8
* mode.
*
- * @param mixed $text Reference to a text
+ * @param mixed &$text Reference to a text
* @return string
*/
public static function compressRevisionText( &$text ) {
* @param string $setting ID of the setting name to retrieve
* @param string $wiki Wiki ID of the wiki in question.
* @param string $suffix The suffix of the wiki in question.
- * @param array $var Reference The variable to insert the value into.
+ * @param array &$var Reference The variable to insert the value into.
* @param array $params List of parameters. $.'key' is replaced by $value in all returned data.
* @param array $wikiTags The tags assigned to the wiki.
*/
* infinite loop when unstubbing an object or to avoid reference parameter
* breakage.
*
- * @param object $obj Object to check.
+ * @param object &$obj Object to check.
* @return void
*/
public static function unstub( &$obj ) {
* Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
*
* @deprecated since 1.25, use MovePage's methods instead
- * @param Title $nt The new title
+ * @param Title &$nt The new title
* @param bool $auth Whether to check user permissions (uses $wgUser)
* @param string $reason Is the log summary of the move, used for spam checking
* @return array|bool True on success, getUserPermissionsErrors()-like array on failure
* Move a title to a new location
*
* @deprecated since 1.25, use the MovePage class instead
- * @param Title $nt The new title
+ * @param Title &$nt The new title
* @param bool $auth Indicates whether $wgUser's permissions
* should be checked
* @param string $reason The reason for the move
* Validate the value against the minimum and user/bot maximum limits.
* Prints usage info on failure.
* @param string $paramName Parameter name
- * @param int $value Parameter value
+ * @param int &$value Parameter value
* @param int|null $min Minimum value
* @param int|null $max Maximum value for users
* @param int $botMax Maximum value for sysops/bots
/**
* Truncate an array to a certain length.
- * @param array $arr Array to truncate
+ * @param array &$arr Array to truncate
* @param int $limit Maximum length
* @return bool True if the array was truncated, false otherwise
*/
*
* @param Page|WikiPage $page Page or WikiPage object to work on
* @param User $user User doing the action
- * @param string|null $reason Reason for the deletion. Autogenerated if null
+ * @param string|null &$reason Reason for the deletion. Autogenerated if null
* @param array $tags Tags to tag the deletion with
* @return Status
*/
* @param Page $page Object to work on
* @param User $user User doing the action
* @param string $oldimage Archive name
- * @param string $reason Reason for the deletion. Autogenerated if null.
+ * @param string &$reason Reason for the deletion. Autogenerated if null.
* @param bool $suppress Whether to mark all deleted versions as restricted
* @param array $tags Tags to tag the deletion with
* @return Status
}
/**
- * @param array $res Result array
+ * @param array &$res Result array
* @param string $key Result key
* @param Message[] $msgs
* @param bool $joinLists
/**
* Add information (title and namespace) about a Title object to a
* result array
- * @param array $arr Result array à la ApiResult
+ * @param array &$arr Result array à la ApiResult
* @param Title $title
* @param string $prefix Module prefix
*/
/**
* @deprecated since 1.25 Use LogFormatter::formatParametersForApi instead
* @param ApiResult $result
- * @param array $vals
+ * @param array &$vals
* @param string $params
* @param string $type
* @param string $action
* Do the query and add the results to a given LinkCache object
* Return an array mapping PDBK to ID
*
- * @param LinkCache $cache
+ * @param LinkCache &$cache
* @return array Remaining IDs
*/
protected function executeInto( &$cache ) {
/**
* @param string $code
- * @param array $where List of wfDebug() comments
+ * @param array &$where List of wfDebug() comments
* @param integer $mode Use MessageCache::FOR_UPDATE to use DB_MASTER
* @return bool|string True on success or one of ("cantacquire", "disabled")
*/
* exists, the data array is returned, otherwise false is returned.
*
* @param string $code
- * @param array $deps
+ * @param array &$deps
* @return array
*/
protected function readSourceFilesAndRegisterDeps( $code, &$deps ) {
* Merge two localisation values, a primary and a fallback, overwriting the
* primary value in place.
* @param string $key
- * @param mixed $value
+ * @param mixed &$value
* @param mixed $fallbackValue
*/
protected function mergeItem( $key, &$value, $fallbackValue ) {
}
/**
- * @param mixed $value
+ * @param mixed &$value
* @param mixed $fallbackValue
*/
protected function mergeMagicWords( &$value, $fallbackValue ) {
* otherwise.
* @param array $codeSequence
* @param string $key
- * @param mixed $value
+ * @param mixed &$value
* @param mixed $fallbackValue
* @return bool
*/
/**
* Generate the feed items given a row from the database, printing the feed.
* @param object $rows IDatabase resource with recentchanges rows
- * @param ChannelFeed $feed
+ * @param ChannelFeed &$feed
*/
public static function generateFeed( $rows, &$feed ) {
$items = self::buildItems( $rows );
*
* @since 1.27
*
- * @param RecentChange $rc Passed by reference
+ * @param RecentChange &$rc Passed by reference
* @param bool $watched (default false)
* @param int $linenumber (default null)
*
}
/**
- * @param string $s HTML to update
+ * @param string &$s HTML to update
* @param mixed $rc_timestamp
*/
public function insertDateHeader( &$s, $rc_timestamp ) {
}
/**
- * @param string $s HTML to update
+ * @param string &$s HTML to update
* @param Title $title
* @param string $logtype
*/
}
/**
- * @param string $s HTML to update
- * @param RecentChange $rc
+ * @param string &$s HTML to update
+ * @param RecentChange &$rc
* @param bool|null $unpatrolled Unused variable, since 1.27.
*/
public function insertDiffHist( &$s, &$rc, $unpatrolled = null ) {
}
/**
- * @param string $s Article link will be appended to this string, in place.
+ * @param string &$s Article link will be appended to this string, in place.
* @param RecentChange $rc
* @param bool $unpatrolled
* @param bool $watched
}
/**
- * @param RecentChange $rc
+ * @param RecentChange &$rc
* @param bool $unpatrolled
* @param bool $watched
* @return string HTML
/**
* Insert time timestamp string from $rc into $s
*
- * @param string $s HTML to update
+ * @param string &$s HTML to update
* @param RecentChange $rc
*/
public function insertTimestamp( &$s, $rc ) {
/** Inserts a rollback link
*
- * @param string $s
- * @param RecentChange $rc
+ * @param string &$s
+ * @param RecentChange &$rc
*/
public function insertRollback( &$s, &$rc ) {
if ( $rc->mAttribs['rc_type'] == RC_EDIT
}
/**
- * @param string $s
- * @param RecentChange $rc
- * @param array $classes
+ * @param string &$s
+ * @param RecentChange &$rc
+ * @param array &$classes
*/
public function insertTags( &$s, &$rc, &$classes ) {
if ( empty( $rc->mAttribs['ts_tags'] ) ) {
/**
* @param RecentChange $rc
- * @param array $classes
+ * @param array &$classes
* @return string
* @since 1.26
*/
/**
* Format a line for enhanced recentchange (aka with javascript and block of lines).
*
- * @param RecentChange $rc
+ * @param RecentChange &$rc
* @param bool $watched
* @param int $linenumber (default null)
*
/**
* Format a line using the old system (aka without any javascript).
*
- * @param RecentChange $rc Passed by reference
+ * @param RecentChange &$rc Passed by reference
* @param bool $watched (default false)
* @param int $linenumber (default null)
*
* Makes an entry in the database corresponding to an edit
*
* @param string $timestamp
- * @param Title $title
+ * @param Title &$title
* @param bool $minor
- * @param User $user
+ * @param User &$user
* @param string $comment
* @param int $oldId
* @param string $lastTimestamp
* Note: the title object must be loaded with the new id using resetArticleID()
*
* @param string $timestamp
- * @param Title $title
+ * @param Title &$title
* @param bool $minor
- * @param User $user
+ * @param User &$user
* @param string $comment
* @param bool $bot
* @param string $ip
/**
* @param string $timestamp
- * @param Title $title
- * @param User $user
+ * @param Title &$title
+ * @param User &$user
* @param string $actionComment
* @param string $ip
* @param string $type
/**
* @param string $timestamp
- * @param Title $title
- * @param User $user
+ * @param Title &$title
+ * @param User &$user
* @param string $actionComment
* @param string $ip
* @param string $type
* if you had ORDER BY foo_timestamp DESC, you will now need GROUP BY foo_timestamp, foo_id
* ORDER BY foo_timestamp DESC, foo_id DESC.
*
- * @param string|array $tables Table names, see Database::select
- * @param string|array $fields Fields used in query, see Database::select
- * @param string|array $conds Conditions used in query, see Database::select
- * @param array $join_conds Join conditions, see Database::select
- * @param string|array $options Options, see Database::select
+ * @param string|array &$tables Table names, see Database::select
+ * @param string|array &$fields Fields used in query, see Database::select
+ * @param string|array &$conds Conditions used in query, see Database::select
+ * @param array &$join_conds Join conditions, see Database::select
+ * @param string|array &$options Options, see Database::select
* @param string|array $filter_tag Tag(s) to select on
*
* @throws MWException When unable to determine appropriate JOIN condition for tagging
/**
* Returns true if the string is _definitely_ in NFC.
* Returns false if not or uncertain.
- * @param string $string a UTF-8 string, altered on output to be valid UTF-8 safe for XML.
+ * @param string &$string a UTF-8 string, altered on output to be valid UTF-8 safe for XML.
* @return bool
*/
static function quickIsNFCVerify( &$string ) {
/**
* Add new field definition to array.
- * @param SearchIndexField[] $fields
+ * @param SearchIndexField[] &$fields
* @param SearchEngine $engine
* @param string $name
* @param int $type
* @param int $revId
* @param ParserOptions $options
* @param bool $generateHtml
- * @param ParserOutput $output
+ * @param ParserOutput &$output
*/
protected function fillParserOutput( Title $title, $revId,
ParserOptions $options, $generateHtml, ParserOutput &$output
* @param int $revId Revision ID (for {{REVISIONID}})
* @param ParserOptions $options Parser options
* @param bool $generateHtml Whether or not to generate HTML
- * @param ParserOutput $output The output object to fill (reference).
+ * @param ParserOutput &$output The output object to fill (reference).
*/
protected function fillParserOutput( Title $title, $revId,
ParserOptions $options, $generateHtml, ParserOutput &$output
}
/**
- * @param IDatabase $db
+ * @param IDatabase &$db
* @param resource $stmt A valid OCI statement identifier
* @param bool $unique
*/
}
/**
- * @param string $sql
+ * @param string &$sql
* @param string $field
* @param int $delta
*/
* @param int $xlen
* @param int $ybeg
* @param int $ylen
- * @param array $edits
+ * @param array &$edits
*
* @throws MWException If the edit type is not known.
*/
protected $sendingThisPage;
/**
- * @param DumpOutput $sink
+ * @param DumpOutput &$sink
*/
function __construct( &$sink ) {
$this->sink =& $sink;
public $namespaces = [];
/**
- * @param DumpOutput $sink
+ * @param DumpOutput &$sink
* @param array $param
* @throws MWException
*/
* various row objects and XML output for filtering. Filters
* can be chained or used as callbacks.
*
- * @param DumpOutput $sink
+ * @param DumpOutput &$sink
*/
public function setOutputSink( &$sink ) {
$this->sink =& $sink;
*
* Used by a subclass to insert extra high resolution images.
* @param MediaTransformOutput $thumb The thumbnail
- * @param array $imageParameters Array of options
+ * @param array &$imageParameters Array of options
*/
protected function adjustImageParameters( $thumb, &$imageParameters ) {
}
* @since 1.23
*
* @param string $fieldname Name of the field
- * @param array $descriptor Input Descriptor, as described above
+ * @param array &$descriptor Input Descriptor, as described above
*
* @throws MWException
* @return string Name of a HTMLFormField subclass
* @param string $path
* @param string $mode
* @param array $options
- * @param string $opened_path
+ * @param string &$opened_path
* @return bool
*/
function stream_open( $path, $mode, $options, &$opened_path ) {
/**
* Alternate per-revision callback, for debugging.
- * @param WikiRevision $revision
+ * @param WikiRevision &$revision
*/
public function debugRevisionHandler( &$revision ) {
$this->debug( "Got revision:" );
protected $holdContentHandlerUseDB = true;
/**
- * @param Database $db To perform updates on
+ * @param Database &$db To perform updates on
* @param bool $shared Whether to perform updates on shared tables
* @param Maintenance $maintenance Maintenance object which created us
*/
}
/**
- * @param Status $status
+ * @param Status &$status
* @return Status
*/
public function setupSearchIndex( &$status ) {
/**
* @param array $jobs
- * @param HashRing $partitionRing
+ * @param HashRing &$partitionRing
* @param int $flags
* @throws JobQueueError
* @return array List of Job object that could not be inserted
* justification for breaking compatibility with installations
* compiled with ./configure --disable-hash.
*
- * @param array $array Array to sort
+ * @param array &$array Array to sort
* @param string $key
* @param string $separator A separator used to delimit the array elements and the
* key. This can be chosen to provide backwards compatibility with
}
/**
- * @param array $req HTTP request map
+ * @param array &$req HTTP request map
* @param array $opts
* - connTimeout : default connection timeout
* - reqTimeout : default request timeout
*
* @param string $fullCont Resolved container name
* @param string $dir Resolved storage directory with no trailing slash
- * @param string|null $after Resolved container relative path to list items after
+ * @param string|null &$after Resolved container relative path to list items after
* @param int $limit Max number of items to list
* @param array $params Parameters for getDirectoryList()
* @return array List of container relative resolved paths of directories directly under $dir
*
* @param string $fullCont Resolved container name
* @param string $dir Resolved storage directory with no trailing slash
- * @param string|null $after Resolved container relative path of file to list items after
+ * @param string|null &$after Resolved container relative path of file to list items after
* @param int $limit Max number of items to list
* @param array $params Parameters for getDirectoryList()
* @return array List of resolved container relative paths of files under $dir
*
* @param string $container Resolved container name
* @param string $dir Resolved path relative to container
- * @param string $after
+ * @param string &$after
* @param int $limit
* @param array $params
* @return Traversable|array
* This must update $predicates for each path that the op can change
* except when a failing StatusValue object is returned.
*
- * @param array $predicates
+ * @param array &$predicates
* @return StatusValue
*/
final public function precheck( array &$predicates ) {
}
/**
- * @param array $predicates
+ * @param array &$predicates
* @return StatusValue
*/
protected function doPrecheck( array &$predicates ) {
* This is useful for early release of locks before function scope is destroyed.
* This is the same as setting the lock object to null.
*
- * @param ScopedLock $lock
+ * @param ScopedLock &$lock
* @since 1.21
*/
public static function release( ScopedLock &$lock = null ) {
* @note: This method is only needed if merge() uses mergeViaCas()
*
* @param string $key
- * @param mixed $casToken
+ * @param mixed &$casToken
* @param integer $flags Bitfield of BagOStuff::READ_* constants [optional]
* @return mixed Returns false on failure and if the item does not exist
* @throws Exception
* That method has cache slam avoiding features for hot/expensive keys.
*
* @param string $key Cache key
- * @param mixed $curTTL Approximate TTL left on the key if present/tombstoned [returned]
+ * @param mixed &$curTTL Approximate TTL left on the key if present/tombstoned [returned]
* @param array $checkKeys List of "check" keys
* @param float &$asOf UNIX timestamp of cached value; null on failure [returned]
* @return mixed Value of cache key or false on failure
* @see WANObjectCache::get()
*
* @param array $keys List of cache keys
- * @param array $curTTLs Map of (key => approximate TTL left) for existing keys [returned]
+ * @param array &$curTTLs Map of (key => approximate TTL left) for existing keys [returned]
* @param array $checkKeys List of check keys to apply to all $keys. May also apply "check"
* keys to specific cache keys only by using cache keys as keys in the $checkKeys array.
* @param float[] &$asOfs Map of (key => UNIX timestamp of cached value; null on failure)
}
/**
- * @param string $sql
- * @param string $newLine
+ * @param string &$sql
+ * @param string &$newLine
* @return bool
*/
public function streamStatementEnd( &$sql, &$newLine ) {
/**
* Show log extract. Either with text and a box (set $msgKey) or without (don't set $msgKey)
*
- * @param OutputPage|string $out By-reference
+ * @param OutputPage|string &$out
* @param string|array $types Log types to show
* @param string|Title $page The page title to show log entries for
* @param string $user The user who made the log entries
* @param string $type
* @param Language|null $lang
* @param Title $title
- * @param array $params
+ * @param array &$params
* @return string
*/
protected static function getTitleLink( $type, $lang, $title, &$params ) {
/**
* @param File $image
- * @param array $params
+ * @param array &$params
* @return bool
*/
function normaliseParams( $image, &$params ) {
/**
* @param File $image
- * @param array $params
+ * @param array &$params
* @return bool
*/
function normaliseParams( $image, &$params ) {
*
* @param File $file File to use
* @param array $extendedMetadata
- * @param int $maxCacheTime Hook handlers might use this parameter to override cache time
+ * @param int &$maxCacheTime Hook handlers might use this parameter to override cache time
*
* @return array [<property name> => ['value' => <value>]], or [] on error
* @since 1.23
/**
* Takes an array returned by the getExtendedMetadata* functions,
* and resolves multi-language values in it.
- * @param array $metadata
+ * @param array &$metadata
* @since 1.23
*/
protected function resolveMultilangMetadata( &$metadata ) {
/**
* Takes an array returned by the getExtendedMetadata* functions,
* and turns all fields into single-valued ones by dropping extra values.
- * @param array $metadata
+ * @param array &$metadata
* @since 1.25
*/
protected function discardMultipleValues( &$metadata ) {
/**
* Makes sure the given array is a valid API response fragment
- * @param array $arr
+ * @param array &$arr
*/
protected function sanitizeArrayForAPI( &$arr ) {
if ( !is_array( $arr ) ) {
/**
* @param File $image
- * @param array $params
+ * @param array &$params
* @return bool
*/
function normaliseParams( $image, &$params ) {
/**
* Validate thumbnail parameters and fill in the correct height
*
- * @param int $width Specified width (input/output)
- * @param int $height Height (output only)
+ * @param int &$width Specified width (input/output)
+ * @param int &$height Height (output only)
* @param int $srcWidth Width of the source image
* @param int $srcHeight Height of the source image
* @param string $mimeType Unused
* Should be idempotent.
* Returns false if the parameters are unacceptable and the transform should fail
* @param File $image
- * @param array $params
+ * @param array &$params
*/
abstract function normaliseParams( $image, &$params );
*
* @see LocalFile::purgeThumbnails
*
- * @param array $files
+ * @param array &$files
* @param array $options Purge options. Currently will always be
* an array with a single key 'forThumbRefresh' set to true.
*/
/**
* @param File $image
- * @param array $params
+ * @param array &$params
* @return bool
*/
function normaliseParams( $image, &$params ) {
abstract class TransformationalImageHandler extends ImageHandler {
/**
* @param File $image
- * @param array $params Transform parameters. Entries with the keys 'width'
+ * @param array &$params Transform parameters. Entries with the keys 'width'
* and 'height' are the respective screen width and height, while the keys
* 'physicalWidth' and 'physicalHeight' indicate the thumbnail dimensions.
* @return bool
* Runs the 'BitmapHandlerCheckImageArea' hook.
*
* @param File $file
- * @param array $params
+ * @param array &$params
* @return bool
* @since 1.25
*/
* On typical message and page data, this can provide a 3X decrease
* in storage requirements.
*
- * @param mixed $data
+ * @param mixed &$data
* @return string
*/
protected function serialize( &$data ) {
/**
* @param array $limit
* @param array $expiry
- * @param bool $cascade
+ * @param bool &$cascade
* @param string $reason
* @param User $user
* @return Status
/**
* @param array $limit
* @param string $reason
- * @param int $cascade
+ * @param int &$cascade
* @param array $expiry
* @return bool
*/
* @param bool $suppress
* @param int $u1 Unused
* @param bool $u2 Unused
- * @param string $error
+ * @param string &$error
* @return bool
*/
public function doDeleteArticle(
* @param string $summary
* @param string $token
* @param bool $bot
- * @param array $resultDetails
+ * @param array &$resultDetails
* @param User|null $user
* @return array
*/
* @param string $fromP
* @param string $summary
* @param bool $bot
- * @param array $resultDetails
+ * @param array &$resultDetails
* @param User|null $guser
* @return array
*/
}
/**
- * @param bool $hasHistory
+ * @param bool &$hasHistory
* @return mixed
*/
public function generateReason( &$hasHistory ) {
* @param string $token Rollback token.
* @param bool $bot If true, mark all reverted edits as bot.
*
- * @param array $resultDetails Array contains result-specific array of additional values
+ * @param array &$resultDetails Array contains result-specific array of additional values
* 'alreadyrolled' : 'current' (rev)
* success : 'summary' (str), 'current' (rev), 'target' (rev)
*
* @param string $summary Custom summary. Set to default summary if empty.
* @param bool $bot If true, mark all reverted edits as bot.
*
- * @param array $resultDetails Contains result-specific array of additional values
+ * @param array &$resultDetails Contains result-specific array of additional values
* @param User $guser The user performing the rollback
* @param array|null $tags Change tags to apply to the rollback
* Callers are responsible for permission checks
/**
* Replace <!--LINK--> link placeholders with actual links, in the buffer
*
- * @param string $text
+ * @param string &$text
*/
public function replace( &$text ) {
$this->replaceInternal( $text );
/**
* Replace internal links
- * @param string $text
+ * @param string &$text
*/
protected function replaceInternal( &$text ) {
if ( !$this->internals ) {
/**
* Replace interwiki links
- * @param string $text
+ * @param string &$text
*/
protected function replaceInterwiki( &$text ) {
if ( empty( $this->interwikis ) ) {
/**
* Modify $this->internals and $colours according to language variant linking rules
- * @param array $colours
+ * @param array &$colours
*/
protected function doVariants( &$colours ) {
global $wgContLang;
*
* @param array $elements List of element names. Comments are always extracted.
* @param string $text Source text string.
- * @param array $matches Out parameter, Array: extracted tags
+ * @param array &$matches Out parameter, Array: extracted tags
* @param string|null $uniq_prefix
* @return string Stripped text
* @since 1.26 The uniq_prefix argument is deprecated.
/**
* Process [[ ]] wikilinks (RIL)
- * @param string $s
+ * @param string &$s
* @throws MWException
* @return LinkHolderArray
*
* Do not reuse this parser instance after calling getUserSig(),
* as it may have changed if it's the $wgParser.
*
- * @param User $user
+ * @param User &$user
* @param string|bool $nickname Nickname to use or false to use user's default nickname
* @param bool|null $fancySig whether the nicknname is the complete signature
* or null to use default value
* Replace "<!--LINK-->" link placeholders with actual links, in the buffer
* Placeholders created in Linker::link()
*
- * @param string $text
+ * @param string &$text
* @param int $options
*/
public function replaceLinkHolders( &$text, $options = 0 ) {
* Callback from the Sanitizer for expanding items found in HTML attribute
* values, so they can be safely tested and escaped.
*
- * @param string $text
+ * @param string &$text
* @param bool|PPFrame $frame
* @return string
*/
abstract public function scopedProfileIn( $section );
/**
- * @param SectionProfileCallback $section
+ * @param SectionProfileCallback &$section
*/
public function scopedProfileOut( SectionProfileCallback &$section = null ) {
$section = null;
}
/**
- * @param ScopedCallback $section
+ * @param ScopedCallback &$section
*/
public function scopedProfileOut( ScopedCallback &$section ) {
$section = null;
* @param int $field The bitmask describing the single option.
* @param int $diff The xor of the old and new bitfields.
* @param int $new The new bitfield
- * @param array $arr The array to update.
+ * @param array &$arr The array to update.
*/
protected static function checkItem( $desc, $field, $diff, $new, &$arr ) {
if ( $diff & $field ) {
/**
* Split text into lines and add it to extracts array
*
- * @param array $extracts Index -> $line
- * @param int $count
+ * @param array &$extracts Index -> $line
+ * @param int &$count
* @param string $text
*/
function splitAndAdd( &$extracts, &$count, $text ) {
* @param string $text
* @param int $start
* @param int $end
- * @param int $posStart (out) actual start position
- * @param int $posEnd (out) actual end position
+ * @param int &$posStart (out) actual start position
+ * @param int &$posEnd (out) actual end position
* @return string
*/
function extract( $text, $start, $end, &$posStart = null, &$posEnd = null ) {
*
* @param string $pattern Regexp for matching lines
* @param array $extracts Extracts to search
- * @param int $linesleft Number of extracts to make
- * @param int $contextchars Length of snippet
- * @param array $out Map for highlighted snippets
- * @param array $offsets Map of starting points of snippets
+ * @param int &$linesleft Number of extracts to make
+ * @param int &$contextchars Length of snippet
+ * @param array &$out Map for highlighted snippets
+ * @param array &$offsets Map of starting points of snippets
* @protected
*/
function process( $pattern, $extracts, &$linesleft, &$contextchars, &$out, &$offsets ) {
/**
* Add special conditions
- * @param array $query
+ * @param array &$query
* @since 1.18
*/
protected function queryFeatures( &$query ) {
/**
* Add namespace conditions
- * @param array $query
+ * @param array &$query
* @since 1.18 (changed)
*/
function queryNamespaces( &$query ) {
/**
* Add limit options
- * @param array $query
+ * @param array &$query
* @since 1.18
*/
protected function limitResult( &$query ) {
/**
* @param string $name
- * @param mixed $value
+ * @param mixed &$value
*/
public function setRef( $name, &$value ) {
$this->data[$name] =& $value;
}
/**
- * @param MediaWikiI18N $t
+ * @param MediaWikiI18N &$t
*/
public function setTranslator( &$t ) {
$this->translator = &$t;
* "<body>" tag, skins can override it if they have a need to add in any
* body attributes or classes of their own.
* @param OutputPage $out
- * @param array $bodyAttrs
+ * @param array &$bodyAttrs
*/
function addToBodyAttributes( $out, &$bodyAttrs ) {
// does nothing by default
/**
* make sure we have some title to operate on
*
- * @param Title $title
+ * @param Title &$title
* @param string $name
*/
static function checkTitle( &$title, $name ) {
*
* This is just a wrapper around addToSidebarPlain() for backwards compatibility
*
- * @param array $bar
+ * @param array &$bar
* @param string $message
*/
public function addToSidebar( &$bar, $message ) {
/**
* Add content from plain text
* @since 1.17
- * @param array $bar
+ * @param array &$bar
* @param string $text
* @return array
*/
* @param AuthenticationRequest[] $requests
* @param array $fieldInfo Field information array (union of all
* AuthenticationRequest::getFieldInfo() responses).
- * @param array $formDescriptor HTMLForm descriptor. The special key 'weight' can be set to
+ * @param array &$formDescriptor HTMLForm descriptor. The special key 'weight' can be set to
* change the order of the fields.
* @param string $action Authentication type (one of the AuthManager::ACTION_* constants)
* @return bool
* Sort the fields of a form descriptor by their 'weight' property. (Fields with higher weight
* are shown closer to the bottom; weight defaults to 0. Negative weight is allowed.)
* Keep order if weights are equal.
- * @param array $formDescriptor
+ * @param array &$formDescriptor
* @return array
*/
protected static function sortFormDescriptorFields( array &$formDescriptor ) {
}
/**
- * @param array $formDescriptor
+ * @param array &$formDescriptor
*/
protected function postProcessFormDescriptor( &$formDescriptor, $requests ) {
// Pre-fill username (if not creating an account, T46775).
* Returns a title object if the page is redirected, false if there was no such special
* page, and true if it was successful.
*
- * @param Title $title
- * @param IContextSource $context
+ * @param Title &$title
+ * @param IContextSource &$context
* @param bool $including Bool output is being captured for use in {{special:whatever}}
* @param LinkRenderer|null $linkRenderer (since 1.28)
*
/**
* If the user has already been blocked with similar settings, load that block
* and change the defaults for the form fields to match the existing settings.
- * @param array $fields HTMLForm descriptor array
+ * @param array &$fields HTMLForm descriptor array
* @return bool Whether fields were altered (that is, whether the target is
* already blocked)
*/
/**
* Filter $rows by categories set in $opts
*
- * @param ResultWrapper $rows Database rows
+ * @param ResultWrapper &$rows Database rows
* @param FormOptions $opts
*/
function filterByCategories( &$rows, FormOptions $opts ) {
* Extract "power search" namespace settings from the request object,
* returning a list of index numbers to search.
*
- * @param WebRequest $request
+ * @param WebRequest &$request
* @return array
*/
protected function powerSearch( &$request ) {
/**
* Create a form of UploadBase depending on wpSourceType and initializes it
*
- * @param WebRequest $request
+ * @param WebRequest &$request
* @param string|null $type
* @return null|UploadBase
*/
/**
* Initialize from a WebRequest. Override this in a subclass.
*
- * @param WebRequest $request
+ * @param WebRequest &$request
*/
abstract public function initializeFromRequest( &$request );
protected $mUpload = null;
/**
- * @param WebRequest $request
+ * @param WebRequest &$request
*/
function initializeFromRequest( &$request ) {
$upload = $request->getUpload( 'wpUploadFile' );
}
/**
- * @param WebRequest $request
+ * @param WebRequest &$request
*/
public function initializeFromRequest( &$request ) {
// sends wpSessionKey as a default when wpFileKey is missing
/**
* Entry point for SpecialUpload
- * @param WebRequest $request
+ * @param WebRequest &$request
*/
public function initializeFromRequest( &$request ) {
$desiredDestName = $request->getText( 'wpDestFile' );
* If e-notif e-mails are on, they will receive notification mails on
* the next change of the page if it's watched etc.
* @note If the user doesn't have 'editmywatchlist', this will do nothing.
- * @param Title $title Title of the article to look at
+ * @param Title &$title Title of the article to look at
* @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
*/
public function clearNotification( &$title, $oldid = 0 ) {
dépôts / lhc / web / wiklou.git / commitdiff