r59182 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r59181‎ | r59182 | r59183 >
Date:20:52, 17 November 2009
Author:ialex
Status:ok
Tags:
Comment:
* removed $this in parameters list since it's a reserved word
* consistency in parameter descriptions
Modified paths:
  • /trunk/phase3/docs/hooks.txt (modified) (history)

Diff [purge]

Index: trunk/phase3/docs/hooks.txt
@@ -519,7 +519,7 @@
520520 &$output: OutputPage object
521521 &$user: User
522522 $request: WebRequest object
523 -$this: Mediawiki object
 523+$mediaWiki: Mediawiki object
524524
525525 'BeforePageDisplay': Prior to outputting a page
526526 &$out: OutputPage object
@@ -556,13 +556,13 @@
557557 'CacheHeadersAfterSet': after cache headers have been set in
558558 OutputPage::sendCacheControl, so they can be overridden without
559559 disabling output method
560 -$this: OutputPage instance
 560+$out: OutputPage instance
561561
562562 'CategoryPageView': before viewing a categorypage in CategoryPage::view
563563 $catpage: CategoryPage instance
564564
565565 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
566 -&$this: ChangesList instance.
 566+&$changesList: ChangesList instance.
567567 &$articlelink: HTML of link to article (already filled-in).
568568 &$s: HTML of row that is being constructed.
569569 &$rc: RecentChange instance.
@@ -790,7 +790,7 @@
791791 'getOtherBlockLogLink': Get links to the block log from extensions which blocks
792792 users and/or IP addresses too
793793 $otherBlockLink: An array with links to other block logs
794 -$$this->ip: The requested IP address or username
 794+$ip: The requested IP address or username
795795
796796 'GetPreferences': modify user preferences
797797 $user: User whose preferences are being modified.
@@ -818,7 +818,7 @@
819819 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
820820 image insertion. You can skip the default logic entirely by returning
821821 false, or just modify a few things using call-by-reference.
822 -&$this: Skin object
 822+&$skin: Skin object
823823 &$title: Title object of the image
824824 &$file: File object, or false if it doesn't exist
825825 &$frameParams: Various parameters with special meanings; see documentation in
@@ -876,9 +876,9 @@
877877
878878 'InternalParseBeforeLinks': during Parser's internalParse method before links
879879 but after noinclude/includeonly/onlyinclude and other processing.
880 -&$this: Parser object
 880+&$parser: Parser object
881881 &$text: string containing partially parsed text
882 -&$this->mStripState: Parser's internal StripState object
 882+&$stripState: Parser's internal StripState object
883883
884884 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
885885 $user: user (object) whose email is being invalidated
@@ -1055,12 +1055,12 @@
10561056 'MediaWikiPerformAction': Override MediaWiki::performAction().
10571057 Use this to do something completely different, after the basic
10581058 globals have been set up, but before ordinary actions take place.
1059 -$output: $wgOut
 1059+$output: $wgOut
10601060 $article: $wgArticle
1061 -$title: $wgTitle
1062 -$user: $wgUser
 1061+$title: $wgTitle
 1062+$user: $wgUser
10631063 $request: $wgRequest
1064 -$this: The $mediawiki object
 1064+$mediaWiki: The $mediawiki object
10651065
10661066 'MessagesPreLoad': When loading a message from the database
10671067 $title: title of the message (string)
@@ -1377,15 +1377,15 @@
13781378 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
13791379 You can either create your own array, or alter the parameters for
13801380 the normal one.
1381 -&$this: The SkinTemplate instance.
1382 -$title: Title instance for the page.
1383 -$message: Visible label of tab.
1384 -$selected: Whether this is a selected tab.
 1381+&$sktemplate: The SkinTemplate instance.
 1382+$title: Title instance for the page.
 1383+$message: Visible label of tab.
 1384+$selected: Whether this is a selected tab.
13851385 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1386 -&$classes: Array of CSS classes to apply.
1387 -&$query: Query string to add to link.
1388 -&$text: Link text.
1389 -&$result: Complete assoc. array if you want to return true.
 1386+&$classes: Array of CSS classes to apply.
 1387+&$query: Query string to add to link.
 1388+&$text: Link text.
 1389+&$result: Complete assoc. array if you want to return true.
13901390
13911391 'SkinTemplateTabs': called when finished to build the actions tabs
13921392 $sktemplate: SkinTemplate object
@@ -1532,19 +1532,19 @@
15331533 $article: article object that was watched
15341534
15351535 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1536 -string $type: the requested upload type
 1536+$type: (string) the requested upload type
15371537 &$className: the class name of the Upload instance to be created
15381538
15391539 'UploadComplete': when Upload completes an upload
15401540 &$upload: an UploadBase child instance
15411541
15421542 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1543 -assembled
1544 -array $descriptor: the HTMLForm descriptor
 1543+ assembled
 1544+$descriptor: (array) the HTMLForm descriptor
15451545
15461546 'UploadFormSourceDescriptors': after the standard source inputs have been
15471547 added to the descriptor
1548 -array $descriptor: the HTMLForm descriptor
 1548+$descriptor: (array) the HTMLForm descriptor
15491549
15501550 'UploadVerification': additional chances to reject an uploaded file
15511551 string $saveName: destination file name

Status & tagging log