Fixed some @params documentation
Swapped some "$var type" to "type $var" or added missing types before the $var. Changed some other types to match the more common spelling. Makes beginning of some text in captial. Change-Id: I64e8cfe478cb0ba438f40b0631d6e9049cdab567
This commit is contained in:
umherirrender
Siebrand
parent
f641b8fdf4
commit
829886b10a
20 changed files with 196 additions and 197 deletions
|
|
@ -30,7 +30,7 @@ class CategoryPage extends Article {
|
|||
protected $mCategoryViewerClass = 'CategoryViewer';
|
||||
|
||||
/**
|
||||
* @param $title Title
|
||||
* @param Title $title
|
||||
* @return WikiCategoryPage
|
||||
*/
|
||||
protected function newPage( Title $title ) {
|
||||
|
|
@ -40,7 +40,7 @@ class CategoryPage extends Article {
|
|||
|
||||
/**
|
||||
* Constructor from a page id
|
||||
* @param int $id article ID to load
|
||||
* @param int $id Article ID to load
|
||||
* @return CategoryPage|null
|
||||
*/
|
||||
public static function newFromID( $id ) {
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ abstract class Collation {
|
|||
|
||||
/**
|
||||
* @throws MWException
|
||||
* @param $collationName string
|
||||
* @param string $collationName
|
||||
* @return Collation
|
||||
*/
|
||||
static function factory( $collationName ) {
|
||||
|
|
|
|||
|
|
@ -295,7 +295,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the URL to redirect to, or an empty string if not redirect URL set
|
||||
*
|
||||
* @return String
|
||||
* @return string
|
||||
*/
|
||||
public function getRedirect() {
|
||||
return $this->mRedirect;
|
||||
|
|
@ -304,7 +304,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Set the HTTP status code to send with the output.
|
||||
*
|
||||
* @param $statusCode Integer
|
||||
* @param int $statusCode
|
||||
*/
|
||||
public function setStatusCode( $statusCode ) {
|
||||
$this->mStatusCode = $statusCode;
|
||||
|
|
@ -355,7 +355,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the value of the "rel" attribute for metadata links
|
||||
*
|
||||
* @return String
|
||||
* @return string
|
||||
*/
|
||||
public function getMetadataAttribute() {
|
||||
# note: buggy CC software only reads first "meta" link
|
||||
|
|
@ -392,7 +392,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get all styles added by extensions
|
||||
*
|
||||
* @return Array
|
||||
* @return array
|
||||
*/
|
||||
function getExtStyle() {
|
||||
return $this->mExtStyles;
|
||||
|
|
@ -431,7 +431,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get all registered JS and CSS tags for the header.
|
||||
*
|
||||
* @return String
|
||||
* @return string
|
||||
*/
|
||||
function getScript() {
|
||||
return $this->mScripts . $this->getHeadItems();
|
||||
|
|
@ -440,10 +440,10 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Filter an array of modules to remove insufficiently trustworthy members, and modules
|
||||
* which are no longer registered (eg a page is cached before an extension is disabled)
|
||||
* @param $modules Array
|
||||
* @param string $position if not null, only return modules with this position
|
||||
* @param $type string
|
||||
* @return Array
|
||||
* @param array $modules
|
||||
* @param string|null $position if not null, only return modules with this position
|
||||
* @param string $type
|
||||
* @return array
|
||||
*/
|
||||
protected function filterModules( $modules, $position = null, $type = ResourceLoaderModule::TYPE_COMBINED ) {
|
||||
$resourceLoader = $this->getResourceLoader();
|
||||
|
|
@ -464,10 +464,10 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the list of modules to include on this page
|
||||
*
|
||||
* @param bool $filter whether to filter out insufficiently trustworthy modules
|
||||
* @param string $position if not null, only return modules with this position
|
||||
* @param $param string
|
||||
* @return Array of module names
|
||||
* @param bool $filter Whether to filter out insufficiently trustworthy modules
|
||||
* @param string|null $position If not null, only return modules with this position
|
||||
* @param string $param
|
||||
* @return array Array of module names
|
||||
*/
|
||||
public function getModules( $filter = false, $position = null, $param = 'mModules' ) {
|
||||
$modules = array_values( array_unique( $this->$param ) );
|
||||
|
|
@ -490,10 +490,10 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the list of module JS to include on this page
|
||||
*
|
||||
* @param $filter
|
||||
* @param $position
|
||||
* @param bool $filter
|
||||
* @param string|null $position
|
||||
*
|
||||
* @return array of module names
|
||||
* @return array Array of module names
|
||||
*/
|
||||
public function getModuleScripts( $filter = false, $position = null ) {
|
||||
return $this->getModules( $filter, $position, 'mModuleScripts' );
|
||||
|
|
@ -513,10 +513,10 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the list of module CSS to include on this page
|
||||
*
|
||||
* @param $filter
|
||||
* @param $position
|
||||
* @param bool $filter
|
||||
* @param string|null $position
|
||||
*
|
||||
* @return Array of module names
|
||||
* @return array Array of module names
|
||||
*/
|
||||
public function getModuleStyles( $filter = false, $position = null ) {
|
||||
return $this->getModules( $filter, $position, 'mModuleStyles' );
|
||||
|
|
@ -538,10 +538,10 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the list of module messages to include on this page
|
||||
*
|
||||
* @param $filter
|
||||
* @param $position
|
||||
* @param bool $filter
|
||||
* @param string|null $position
|
||||
*
|
||||
* @return Array of module names
|
||||
* @return array Array of module names
|
||||
*/
|
||||
public function getModuleMessages( $filter = false, $position = null ) {
|
||||
return $this->getModules( $filter, $position, 'mModuleMessages' );
|
||||
|
|
@ -568,7 +568,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Sets ResourceLoader target for load.php links. If null, will be omitted
|
||||
*
|
||||
* @param $target string|null
|
||||
* @param string|null $target
|
||||
*/
|
||||
public function setTarget( $target ) {
|
||||
$this->mTarget = $target;
|
||||
|
|
@ -577,7 +577,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get an array of head items
|
||||
*
|
||||
* @return Array
|
||||
* @return array
|
||||
*/
|
||||
function getHeadItemsArray() {
|
||||
return $this->mHeadItems;
|
||||
|
|
@ -586,7 +586,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get all header items in a string
|
||||
*
|
||||
* @return String
|
||||
* @return string
|
||||
*/
|
||||
function getHeadItems() {
|
||||
$s = '';
|
||||
|
|
@ -609,8 +609,8 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Check if the header item $name is already set
|
||||
*
|
||||
* @param string $name item name
|
||||
* @return Boolean
|
||||
* @param string $name Item name
|
||||
* @return bool
|
||||
*/
|
||||
public function hasHeadItem( $name ) {
|
||||
return isset( $this->mHeadItems[$name] );
|
||||
|
|
@ -639,7 +639,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Return whether the output will contain only the body of the article
|
||||
*
|
||||
* @return Boolean
|
||||
* @return bool
|
||||
*/
|
||||
public function getArticleBodyOnly() {
|
||||
return $this->mArticleBodyOnly;
|
||||
|
|
@ -833,7 +833,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the value of the "action text"
|
||||
*
|
||||
* @return String
|
||||
* @return string
|
||||
*/
|
||||
public function getPageTitleActionText() {
|
||||
if ( isset( $this->mPageTitleActionText ) ) {
|
||||
|
|
@ -846,7 +846,7 @@ class OutputPage extends ContextSource {
|
|||
* "HTML title" means the contents of "<title>".
|
||||
* It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
|
||||
*
|
||||
* @param $name string
|
||||
* @param string $name
|
||||
*/
|
||||
public function setHTMLTitle( $name ) {
|
||||
if ( $name instanceof Message ) {
|
||||
|
|
@ -859,7 +859,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Return the "HTML title", i.e. the content of the "<title>" tag.
|
||||
*
|
||||
* @return String
|
||||
* @return string
|
||||
*/
|
||||
public function getHTMLTitle() {
|
||||
return $this->mHTMLtitle;
|
||||
|
|
@ -868,7 +868,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Set $mRedirectedFrom, the Title of the page which redirected us to the current page.
|
||||
*
|
||||
* @param $t Title
|
||||
* @param Title $t
|
||||
*/
|
||||
public function setRedirectedFrom( $t ) {
|
||||
$this->mRedirectedFrom = $t;
|
||||
|
|
@ -880,7 +880,7 @@ class OutputPage extends ContextSource {
|
|||
* This function automatically sets \<title\> to the same content as \<h1\> but with all tags removed.
|
||||
* Bad tags that were escaped in \<h1\> will still be escaped in \<title\>, and good tags like \<i\> will be dropped entirely.
|
||||
*
|
||||
* @param $name string|Message
|
||||
* @param string|Message $name
|
||||
*/
|
||||
public function setPageTitle( $name ) {
|
||||
if ( $name instanceof Message ) {
|
||||
|
|
@ -902,7 +902,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Return the "page title", i.e. the content of the \<h1\> tag.
|
||||
*
|
||||
* @return String
|
||||
* @return string
|
||||
*/
|
||||
public function getPageTitle() {
|
||||
return $this->mPagetitle;
|
||||
|
|
@ -911,7 +911,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Set the Title object to use
|
||||
*
|
||||
* @param $t Title object
|
||||
* @param Title $t
|
||||
*/
|
||||
public function setTitle( Title $t ) {
|
||||
$this->getContext()->setTitle( $t );
|
||||
|
|
@ -953,7 +953,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Add a subtitle containing a backlink to a page
|
||||
*
|
||||
* @param $title Title to link to
|
||||
* @param Title $title Title to link to
|
||||
*/
|
||||
public function addBacklinkSubtitle( Title $title ) {
|
||||
$query = array();
|
||||
|
|
@ -973,7 +973,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the subtitle
|
||||
*
|
||||
* @return String
|
||||
* @return string
|
||||
*/
|
||||
public function getSubtitle() {
|
||||
return implode( "<br />\n\t\t\t\t", $this->mSubtitle );
|
||||
|
|
@ -990,7 +990,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Return whether the page is "printable"
|
||||
*
|
||||
* @return Boolean
|
||||
* @return bool
|
||||
*/
|
||||
public function isPrintable() {
|
||||
return $this->mPrintable;
|
||||
|
|
@ -1006,7 +1006,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Return whether the output will be completely disabled
|
||||
*
|
||||
* @return Boolean
|
||||
* @return bool
|
||||
*/
|
||||
public function isDisabled() {
|
||||
return $this->mDoNothing;
|
||||
|
|
@ -1015,7 +1015,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Show an "add new section" link?
|
||||
*
|
||||
* @return Boolean
|
||||
* @return bool
|
||||
*/
|
||||
public function showNewSectionLink() {
|
||||
return $this->mNewSectionLink;
|
||||
|
|
@ -1024,7 +1024,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Forcibly hide the new section link?
|
||||
*
|
||||
* @return Boolean
|
||||
* @return bool
|
||||
*/
|
||||
public function forceHideNewSectionLink() {
|
||||
return $this->mHideNewSectionLink;
|
||||
|
|
@ -1085,7 +1085,7 @@ class OutputPage extends ContextSource {
|
|||
|
||||
/**
|
||||
* Should we output feed links for this page?
|
||||
* @return Boolean
|
||||
* @return bool
|
||||
*/
|
||||
public function isSyndicated() {
|
||||
return count( $this->mFeedLinks ) > 0;
|
||||
|
|
@ -1113,7 +1113,7 @@ class OutputPage extends ContextSource {
|
|||
* corresponding article on the wiki
|
||||
* Setting true will cause the change "article related" toggle to true
|
||||
*
|
||||
* @param $v Boolean
|
||||
* @param bool $v
|
||||
*/
|
||||
public function setArticleFlag( $v ) {
|
||||
$this->mIsarticle = $v;
|
||||
|
|
@ -1126,7 +1126,7 @@ class OutputPage extends ContextSource {
|
|||
* Return whether the content displayed page is related to the source of
|
||||
* the corresponding article on the wiki
|
||||
*
|
||||
* @return Boolean
|
||||
* @return bool
|
||||
*/
|
||||
public function isArticle() {
|
||||
return $this->mIsarticle;
|
||||
|
|
@ -1136,7 +1136,7 @@ class OutputPage extends ContextSource {
|
|||
* Set whether this page is related an article on the wiki
|
||||
* Setting false will cause the change of "article flag" toggle to false
|
||||
*
|
||||
* @param $v Boolean
|
||||
* @param bool $v
|
||||
*/
|
||||
public function setArticleRelated( $v ) {
|
||||
$this->mIsArticleRelated = $v;
|
||||
|
|
@ -1148,7 +1148,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Return whether this page is related an article on the wiki
|
||||
*
|
||||
* @return Boolean
|
||||
* @return bool
|
||||
*/
|
||||
public function isArticleRelated() {
|
||||
return $this->mIsArticleRelated;
|
||||
|
|
@ -1177,7 +1177,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the list of language links
|
||||
*
|
||||
* @return Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
|
||||
* @return array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
|
||||
*/
|
||||
public function getLanguageLinks() {
|
||||
return $this->mLanguageLinks;
|
||||
|
|
@ -1260,7 +1260,7 @@ class OutputPage extends ContextSource {
|
|||
* hidden categories) and $link a HTML fragment with a link to the category
|
||||
* page
|
||||
*
|
||||
* @return Array
|
||||
* @return array
|
||||
*/
|
||||
public function getCategoryLinks() {
|
||||
return $this->mCategoryLinks;
|
||||
|
|
@ -1269,7 +1269,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the list of category names this page belongs to
|
||||
*
|
||||
* @return Array of strings
|
||||
* @return array Array of strings
|
||||
*/
|
||||
public function getCategories() {
|
||||
return $this->mCategories;
|
||||
|
|
@ -1290,7 +1290,7 @@ class OutputPage extends ContextSource {
|
|||
* Return whether user JavaScript is allowed for this page
|
||||
* @deprecated since 1.18 Load modules with ResourceLoader, and origin and
|
||||
* trustworthiness is identified and enforced automagically.
|
||||
* @return Boolean
|
||||
* @return bool
|
||||
*/
|
||||
public function isUserJsAllowed() {
|
||||
wfDeprecated( __METHOD__, '1.18' );
|
||||
|
|
@ -1301,7 +1301,7 @@ class OutputPage extends ContextSource {
|
|||
* Show what level of JavaScript / CSS untrustworthiness is allowed on this page
|
||||
* @see ResourceLoaderModule::$origin
|
||||
* @param string $type ResourceLoaderModule TYPE_ constant
|
||||
* @return Int ResourceLoaderModule ORIGIN_ class constant
|
||||
* @return int ResourceLoaderModule ORIGIN_ class constant
|
||||
*/
|
||||
public function getAllowedModules( $type ) {
|
||||
if ( $type == ResourceLoaderModule::TYPE_COMBINED ) {
|
||||
|
|
@ -1315,8 +1315,8 @@ class OutputPage extends ContextSource {
|
|||
|
||||
/**
|
||||
* Set the highest level of CSS/JS untrustworthiness allowed
|
||||
* @param $type String ResourceLoaderModule TYPE_ constant
|
||||
* @param $level Int ResourceLoaderModule class constant
|
||||
* @param string $type ResourceLoaderModule TYPE_ constant
|
||||
* @param int $level ResourceLoaderModule class constant
|
||||
*/
|
||||
public function setAllowedModules( $type, $level ) {
|
||||
$this->mAllowedModules[$type] = $level;
|
||||
|
|
@ -1324,8 +1324,8 @@ class OutputPage extends ContextSource {
|
|||
|
||||
/**
|
||||
* As for setAllowedModules(), but don't inadvertently make the page more accessible
|
||||
* @param $type String
|
||||
* @param $level Int ResourceLoaderModule class constant
|
||||
* @param string $type
|
||||
* @param int $level ResourceLoaderModule class constant
|
||||
*/
|
||||
public function reduceAllowedModules( $type, $level ) {
|
||||
$this->mAllowedModules[$type] = min( $this->getAllowedModules( $type ), $level );
|
||||
|
|
@ -1354,9 +1354,9 @@ class OutputPage extends ContextSource {
|
|||
*
|
||||
* @since 1.19
|
||||
*
|
||||
* @param $element string
|
||||
* @param $attribs array
|
||||
* @param $contents string
|
||||
* @param string $element
|
||||
* @param array $attribs
|
||||
* @param string $contents
|
||||
*/
|
||||
public function addElement( $element, $attribs = array(), $contents = '' ) {
|
||||
$this->addHTML( Html::element( $element, $attribs, $contents ) );
|
||||
|
|
@ -1381,9 +1381,9 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get/set the ParserOptions object to use for wikitext parsing
|
||||
*
|
||||
* @param $options ParserOptions|null either the ParserOption to use or null to only get the
|
||||
* current ParserOption object
|
||||
* @return ParserOptions object
|
||||
* @param ParserOptions|null $options Either the ParserOption to use or null to only get the
|
||||
* current ParserOption object
|
||||
* @return ParserOptions
|
||||
*/
|
||||
public function parserOptions( $options = null ) {
|
||||
if ( !$this->mParserOptions ) {
|
||||
|
|
@ -1408,7 +1408,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the displayed revision ID
|
||||
*
|
||||
* @return Integer
|
||||
* @return int
|
||||
*/
|
||||
public function getRevisionId() {
|
||||
return $this->mRevisionId;
|
||||
|
|
@ -1429,7 +1429,7 @@ class OutputPage extends ContextSource {
|
|||
* Get the timestamp of displayed revision.
|
||||
* This will be null if not filled by setRevisionTimestamp().
|
||||
*
|
||||
* @return String or null
|
||||
* @return string|null
|
||||
*/
|
||||
public function getRevisionTimestamp() {
|
||||
return $this->mRevisionTimestamp;
|
||||
|
|
@ -1452,7 +1452,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the displayed file version
|
||||
*
|
||||
* @return Array|null ('time' => MW timestamp, 'sha1' => sha1)
|
||||
* @return array|null ('time' => MW timestamp, 'sha1' => sha1)
|
||||
*/
|
||||
public function getFileVersion() {
|
||||
return $this->mFileVersion;
|
||||
|
|
@ -1461,7 +1461,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the templates used on this page
|
||||
*
|
||||
* @return Array (namespace => dbKey => revId)
|
||||
* @return array (namespace => dbKey => revId)
|
||||
* @since 1.18
|
||||
*/
|
||||
public function getTemplateIds() {
|
||||
|
|
@ -1471,7 +1471,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the files used on this page
|
||||
*
|
||||
* @return Array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
|
||||
* @return array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
|
||||
* @since 1.18
|
||||
*/
|
||||
public function getFileSearchOptions() {
|
||||
|
|
@ -1561,7 +1561,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Add a ParserOutput object, but without Html
|
||||
*
|
||||
* @param $parserOutput ParserOutput object
|
||||
* @param ParserOutput $parserOutput
|
||||
*/
|
||||
public function addParserOutputNoText( &$parserOutput ) {
|
||||
$this->mLanguageLinks += $parserOutput->getLanguageLinks();
|
||||
|
|
@ -1613,7 +1613,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Add a ParserOutput object
|
||||
*
|
||||
* @param $parserOutput ParserOutput
|
||||
* @param ParserOutput $parserOutput
|
||||
*/
|
||||
function addParserOutput( &$parserOutput ) {
|
||||
$this->addParserOutputNoText( $parserOutput );
|
||||
|
|
@ -1631,7 +1631,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Add the output of a QuickTemplate to the output buffer
|
||||
*
|
||||
* @param $template QuickTemplate
|
||||
* @param QuickTemplate $template
|
||||
*/
|
||||
public function addTemplate( &$template ) {
|
||||
$this->addHTML( $template->getHTML() );
|
||||
|
|
@ -1640,7 +1640,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Parse wikitext and return the HTML.
|
||||
*
|
||||
* @param String $text
|
||||
* @param string $text
|
||||
* @param bool $linestart Is this the start of a line?
|
||||
* @param bool $interface Use interface language ($wgLang instead of
|
||||
* $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL.
|
||||
|
|
@ -1712,7 +1712,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Use enableClientCache(false) to force it to send nocache headers
|
||||
*
|
||||
* @param $state bool
|
||||
* @param bool $state
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
|
|
@ -1723,7 +1723,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get the list of cookies that will influence on the cache
|
||||
*
|
||||
* @return Array
|
||||
* @return array
|
||||
*/
|
||||
function getCacheVaryCookies() {
|
||||
global $wgCookiePrefix, $wgCacheVaryCookies;
|
||||
|
|
@ -1747,7 +1747,7 @@ class OutputPage extends ContextSource {
|
|||
* Check if the request has a cache-varying cookie header
|
||||
* If it does, it's very important that we don't allow public caching
|
||||
*
|
||||
* @return Boolean
|
||||
* @return bool
|
||||
*/
|
||||
function haveCacheVaryCookies() {
|
||||
$cookieHeader = $this->getRequest()->getHeader( 'cookie' );
|
||||
|
|
@ -1770,7 +1770,7 @@ class OutputPage extends ContextSource {
|
|||
* Add an HTTP header that will influence on the cache
|
||||
*
|
||||
* @param string $header header name
|
||||
* @param $option Array|null
|
||||
* @param array|null $option
|
||||
* @todo FIXME: Document the $option parameter; it appears to be for
|
||||
* X-Vary-Options but what format is acceptable?
|
||||
*/
|
||||
|
|
@ -1791,7 +1791,7 @@ class OutputPage extends ContextSource {
|
|||
* Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
|
||||
* such as Accept-Encoding or Cookie
|
||||
*
|
||||
* @return String
|
||||
* @return string
|
||||
*/
|
||||
public function getVaryHeader() {
|
||||
return 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader ) );
|
||||
|
|
@ -1800,7 +1800,7 @@ class OutputPage extends ContextSource {
|
|||
/**
|
||||
* Get a complete X-Vary-Options header
|
||||
*
|
||||
* @return String
|
||||
* @return string
|
||||
*/
|
||||
public function getXVO() {
|
||||
$cvCookies = $this->getCacheVaryCookies();
|
||||
|
|
@ -1864,7 +1864,7 @@ class OutputPage extends ContextSource {
|
|||
* This is the default for special pages. If you display a CSRF-protected
|
||||
* form on an ordinary view page, then you need to call this function.
|
||||
*
|
||||
* @param $enable bool
|
||||
* @param bool $enable
|
||||
*/
|
||||
public function preventClickjacking( $enable = true ) {
|
||||
$this->mPreventClickjacking = $enable;
|
||||
|
|
@ -2442,10 +2442,10 @@ $templates
|
|||
/**
|
||||
* Add a "return to" link pointing to a specified title
|
||||
*
|
||||
* @param $title Title to link
|
||||
* @param array $query query string parameters
|
||||
* @param string $text text of the link (input is not escaped)
|
||||
* @param $options Options array to pass to Linker
|
||||
* @param Title $title Title to link
|
||||
* @param array $query Query string parameters
|
||||
* @param string $text Text of the link (input is not escaped)
|
||||
* @param array $options Options array to pass to Linker
|
||||
*/
|
||||
public function addReturnTo( $title, $query = array(), $text = null, $options = array() ) {
|
||||
$link = $this->msg( 'returnto' )->rawParams(
|
||||
|
|
@ -2457,9 +2457,9 @@ $templates
|
|||
* Add a "return to" link pointing to a specified title,
|
||||
* or the title indicated in the request, or else the main page
|
||||
*
|
||||
* @param $unused
|
||||
* @param $returnto Title or String to return to
|
||||
* @param string $returntoquery query string for the return to link
|
||||
* @param mixed $unused
|
||||
* @param Title|string $returnto Title or String to return to
|
||||
* @param string $returntoquery Query string for the return to link
|
||||
*/
|
||||
public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
|
||||
if ( $returnto == null ) {
|
||||
|
|
@ -2588,9 +2588,9 @@ $templates
|
|||
* TODO: Document
|
||||
* @param array|string $modules One or more module names
|
||||
* @param string $only ResourceLoaderModule TYPE_ class constant
|
||||
* @param boolean $useESI
|
||||
* @param array $extraQuery with extra query parameters to add to each request. array( param => value )
|
||||
* @param boolean $loadCall If true, output an (asynchronous) mw.loader.load() call rather than a "<script src='...'>" tag
|
||||
* @param bool $useESI
|
||||
* @param array $extraQuery Array with extra query parameters to add to each request. array( param => value )
|
||||
* @param bool $loadCall If true, output an (asynchronous) mw.loader.load() call rather than a "<script src='...'>" tag
|
||||
* @return string The html "<script>", "<link>" and "<style>" tags
|
||||
*/
|
||||
protected function makeResourceLoaderLink( $modules, $only, $useESI = false, array $extraQuery = array(), $loadCall = false ) {
|
||||
|
|
@ -2864,7 +2864,7 @@ $templates
|
|||
* modules marked with position 'bottom', legacy scripts ($this->mScripts),
|
||||
* user preferences, site JS and user JS.
|
||||
*
|
||||
* @param $inHead boolean If true, this HTML goes into the "<head>", if false it goes into the "<body>"
|
||||
* @param bool $inHead If true, this HTML goes into the "<head>", if false it goes into the "<body>"
|
||||
* @return string
|
||||
*/
|
||||
function getScriptsForBottomQueue( $inHead ) {
|
||||
|
|
@ -2954,7 +2954,7 @@ $templates
|
|||
/**
|
||||
* Get the javascript config vars to include on this page
|
||||
*
|
||||
* @return Array of javascript config vars
|
||||
* @return array Array of javascript config vars
|
||||
* @since 1.23
|
||||
*/
|
||||
public function getJsConfigVars() {
|
||||
|
|
@ -2962,10 +2962,10 @@ $templates
|
|||
}
|
||||
|
||||
/**
|
||||
* Add one or more variables to be set in mw.config in JavaScript.
|
||||
* Add one or more variables to be set in mw.config in JavaScript
|
||||
*
|
||||
* @param $keys {String|Array} Key or array of key/value pairs.
|
||||
* @param $value {Mixed} [optional] Value of the configuration variable.
|
||||
* @param string|array $keys Key or array of key/value pairs
|
||||
* @param mixed $value [optional] Value of the configuration variable
|
||||
*/
|
||||
public function addJsConfigVars( $keys, $value = null ) {
|
||||
if ( is_array( $keys ) ) {
|
||||
|
|
@ -3483,7 +3483,7 @@ $templates
|
|||
}
|
||||
|
||||
/**
|
||||
* @return Array
|
||||
* @return array
|
||||
*/
|
||||
public function buildCssLinksArray() {
|
||||
$links = array();
|
||||
|
|
@ -3604,8 +3604,8 @@ $templates
|
|||
* Like addWikiMsg() except the parameters are taken as an array
|
||||
* instead of a variable argument list.
|
||||
*
|
||||
* @param $name string
|
||||
* @param $args array
|
||||
* @param string $name
|
||||
* @param array $args
|
||||
*/
|
||||
public function addWikiMsgArray( $name, $args ) {
|
||||
$this->addHTML( $this->msg( $name, $args )->parseAsBlock() );
|
||||
|
|
@ -3632,7 +3632,7 @@ $templates
|
|||
*
|
||||
* The newline after opening div is needed in some wikitext. See bug 19226.
|
||||
*
|
||||
* @param $wrap string
|
||||
* @param string $wrap
|
||||
*/
|
||||
public function wrapWikiMsg( $wrap /*, ...*/ ) {
|
||||
$msgSpecs = func_get_args();
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@
|
|||
*/
|
||||
abstract class TitleArray implements Iterator {
|
||||
/**
|
||||
* @param $res ResultWrapper A SQL result including at least page_namespace and
|
||||
* @param ResultWrapper $res A SQL result including at least page_namespace and
|
||||
* page_title -- also can have page_id, page_len, page_is_redirect,
|
||||
* page_latest (if those will be used). See Title::newFromRow.
|
||||
* @return TitleArrayFromResult
|
||||
|
|
@ -47,7 +47,7 @@ abstract class TitleArray implements Iterator {
|
|||
}
|
||||
|
||||
/**
|
||||
* @param $res ResultWrapper
|
||||
* @param ResultWrapper $res
|
||||
* @return TitleArrayFromResult
|
||||
*/
|
||||
protected static function newFromResult_internal( $res ) {
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ class TitleArrayFromResult extends TitleArray implements Countable {
|
|||
}
|
||||
|
||||
/**
|
||||
* @param $row ResultWrapper
|
||||
* @param bool|ResultWrapper $row
|
||||
* @return void
|
||||
*/
|
||||
protected function setCurrent( $row ) {
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@
|
|||
|
||||
abstract class UserArray implements Iterator {
|
||||
/**
|
||||
* @param $res ResultWrapper
|
||||
* @param ResultWrapper $res
|
||||
* @return UserArrayFromResult
|
||||
*/
|
||||
static function newFromResult( $res ) {
|
||||
|
|
@ -37,7 +37,7 @@ abstract class UserArray implements Iterator {
|
|||
}
|
||||
|
||||
/**
|
||||
* @param $ids array
|
||||
* @param array $ids
|
||||
* @return UserArrayFromResult
|
||||
*/
|
||||
static function newFromIDs( $ids ) {
|
||||
|
|
@ -57,7 +57,7 @@ abstract class UserArray implements Iterator {
|
|||
}
|
||||
|
||||
/**
|
||||
* @param $res
|
||||
* @param ResultWrapper $res
|
||||
* @return UserArrayFromResult
|
||||
*/
|
||||
protected static function newFromResult_internal( $res ) {
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ class UserArrayFromResult extends UserArray implements Countable {
|
|||
var $key, $current;
|
||||
|
||||
/**
|
||||
* @param $res ResultWrapper
|
||||
* @param ResultWrapper $res
|
||||
*/
|
||||
function __construct( $res ) {
|
||||
$this->res = $res;
|
||||
|
|
@ -38,7 +38,7 @@ class UserArrayFromResult extends UserArray implements Countable {
|
|||
}
|
||||
|
||||
/**
|
||||
* @param $row
|
||||
* @param bool|stdClass $row
|
||||
* @return void
|
||||
*/
|
||||
protected function setCurrent( $row ) {
|
||||
|
|
|
|||
|
|
@ -28,11 +28,10 @@
|
|||
class WebResponse {
|
||||
|
||||
/**
|
||||
* Output a HTTP header, wrapper for PHP's
|
||||
* header()
|
||||
* Output a HTTP header, wrapper for PHP's header()
|
||||
* @param string $string header to output
|
||||
* @param bool $replace replace current similar header
|
||||
* @param $http_response_code null|int Forces the HTTP response code to the specified value.
|
||||
* @param null|int $http_response_code Forces the HTTP response code to the specified value.
|
||||
*/
|
||||
public function header( $string, $replace = true, $http_response_code = null ) {
|
||||
header( $string, $replace, $http_response_code );
|
||||
|
|
@ -126,7 +125,7 @@ class FauxResponse extends WebResponse {
|
|||
* Stores a HTTP header
|
||||
* @param string $string header to output
|
||||
* @param bool $replace replace current similar header
|
||||
* @param $http_response_code null|int Forces the HTTP response code to the specified value.
|
||||
* @param null|int $http_response_code Forces the HTTP response code to the specified value.
|
||||
*/
|
||||
public function header( $string, $replace = true, $http_response_code = null ) {
|
||||
if ( substr( $string, 0, 5 ) == 'HTTP/' ) {
|
||||
|
|
@ -163,7 +162,7 @@ class FauxResponse extends WebResponse {
|
|||
/**
|
||||
* Get the HTTP response code, null if not set
|
||||
*
|
||||
* @return Int or null
|
||||
* @return int|null
|
||||
*/
|
||||
public function getStatusCode() {
|
||||
return $this->code;
|
||||
|
|
@ -182,7 +181,7 @@ class FauxResponse extends WebResponse {
|
|||
}
|
||||
|
||||
/**
|
||||
* @param $name string
|
||||
* @param string $name
|
||||
* @return string
|
||||
*/
|
||||
public function getcookie( $name ) {
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ class WikiFilePage extends WikiPage {
|
|||
}
|
||||
|
||||
/**
|
||||
* @param $file File:
|
||||
* @param File $file
|
||||
*/
|
||||
public function setFile( $file ) {
|
||||
$this->mFile = $file;
|
||||
|
|
|
|||
|
|
@ -50,15 +50,15 @@ abstract class Action {
|
|||
|
||||
/**
|
||||
* The fields used to create the HTMLForm
|
||||
* @var Array $fields
|
||||
* @var array $fields
|
||||
*/
|
||||
protected $fields;
|
||||
|
||||
/**
|
||||
* Get the Action subclass which should be used to handle this action, false if
|
||||
* the action is disabled, or null if it's not recognised
|
||||
* @param $action String
|
||||
* @param $overrides Array
|
||||
* @param string $action
|
||||
* @param array $overrides
|
||||
* @return bool|null|string|callable
|
||||
*/
|
||||
final private static function getClass( $action, array $overrides ) {
|
||||
|
|
@ -82,10 +82,10 @@ abstract class Action {
|
|||
|
||||
/**
|
||||
* Get an appropriate Action subclass for the given action
|
||||
* @param $action String
|
||||
* @param $page Page
|
||||
* @param $context IContextSource
|
||||
* @return Action|bool|null false if the action is disabled, null
|
||||
* @param string $action
|
||||
* @param Page $page
|
||||
* @param IContextSource $context
|
||||
* @return Action|bool|null False if the action is disabled, null
|
||||
* if it is not recognised
|
||||
*/
|
||||
final public static function factory( $action, Page $page, IContextSource $context = null ) {
|
||||
|
|
@ -109,8 +109,8 @@ abstract class Action {
|
|||
* $wgActions will be replaced by "nosuchaction".
|
||||
*
|
||||
* @since 1.19
|
||||
* @param $context IContextSource
|
||||
* @return string: action name
|
||||
* @param IContextSource $context
|
||||
* @return string Action name
|
||||
*/
|
||||
final public static function getActionName( IContextSource $context ) {
|
||||
global $wgActions;
|
||||
|
|
@ -153,8 +153,8 @@ abstract class Action {
|
|||
/**
|
||||
* Check if a given action is recognised, even if it's disabled
|
||||
*
|
||||
* @param string $name name of an action
|
||||
* @return Bool
|
||||
* @param string $name Name of an action
|
||||
* @return bool
|
||||
*/
|
||||
final public static function exists( $name ) {
|
||||
return self::getClass( $name, array() ) !== null;
|
||||
|
|
@ -245,7 +245,7 @@ abstract class Action {
|
|||
* Get a Message object with context set
|
||||
* Parameters are the same as wfMessage()
|
||||
*
|
||||
* @return Message object
|
||||
* @return Message
|
||||
*/
|
||||
final public function msg() {
|
||||
$params = func_get_args();
|
||||
|
|
@ -257,8 +257,8 @@ abstract class Action {
|
|||
*
|
||||
* Only public since 1.21
|
||||
*
|
||||
* @param $page Page
|
||||
* @param $context IContextSource
|
||||
* @param Page $page
|
||||
* @param IContextSource $context
|
||||
*/
|
||||
public function __construct( Page $page, IContextSource $context = null ) {
|
||||
if ( $context === null ) {
|
||||
|
|
@ -273,14 +273,14 @@ abstract class Action {
|
|||
|
||||
/**
|
||||
* Return the name of the action this object responds to
|
||||
* @return String lowercase
|
||||
* @return string Lowercase name
|
||||
*/
|
||||
abstract public function getName();
|
||||
|
||||
/**
|
||||
* Get the permission required to perform this action. Often, but not always,
|
||||
* the same as the action name
|
||||
* @return String|null
|
||||
* @return string|null
|
||||
*/
|
||||
public function getRestriction() {
|
||||
return null;
|
||||
|
|
@ -291,7 +291,7 @@ abstract class Action {
|
|||
* overridden by sub-classes with more complicated permissions schemes. Failures here
|
||||
* must throw subclasses of ErrorPageError
|
||||
*
|
||||
* @param $user User: the user to check, or null to use the context user
|
||||
* @param User $user The user to check, or null to use the context user
|
||||
* @throws UserBlockedError|ReadOnlyError|PermissionsError
|
||||
* @return bool True on success
|
||||
*/
|
||||
|
|
@ -320,7 +320,7 @@ abstract class Action {
|
|||
|
||||
/**
|
||||
* Whether this action requires the wiki not to be locked
|
||||
* @return Bool
|
||||
* @return bool
|
||||
*/
|
||||
public function requiresWrite() {
|
||||
return true;
|
||||
|
|
@ -328,7 +328,7 @@ abstract class Action {
|
|||
|
||||
/**
|
||||
* Whether this action can still be executed by a blocked user
|
||||
* @return Bool
|
||||
* @return bool
|
||||
*/
|
||||
public function requiresUnblock() {
|
||||
return true;
|
||||
|
|
@ -349,7 +349,7 @@ abstract class Action {
|
|||
/**
|
||||
* Returns the name that goes in the \<h1\> page title
|
||||
*
|
||||
* @return String
|
||||
* @return string
|
||||
*/
|
||||
protected function getPageTitle() {
|
||||
return $this->getTitle()->getPrefixedText();
|
||||
|
|
@ -358,7 +358,7 @@ abstract class Action {
|
|||
/**
|
||||
* Returns the description that goes below the \<h1\> tag
|
||||
*
|
||||
* @return String
|
||||
* @return string
|
||||
*/
|
||||
protected function getDescription() {
|
||||
return $this->msg( strtolower( $this->getName() ) )->escaped();
|
||||
|
|
@ -374,7 +374,7 @@ abstract class Action {
|
|||
|
||||
/**
|
||||
* Execute the action in a silent fashion: do not display anything or release any errors.
|
||||
* @return Bool whether execution was successful
|
||||
* @return bool whether execution was successful
|
||||
*/
|
||||
abstract public function execute();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ abstract class CachedAction extends FormlessAction implements ICacheHelper {
|
|||
* If the cache is enabled or not.
|
||||
*
|
||||
* @since 1.20
|
||||
* @var boolean
|
||||
* @var bool
|
||||
*/
|
||||
protected $cacheEnabled = true;
|
||||
|
||||
|
|
@ -66,7 +66,7 @@ abstract class CachedAction extends FormlessAction implements ICacheHelper {
|
|||
* Sets if the cache should be enabled or not.
|
||||
*
|
||||
* @since 1.20
|
||||
* @param boolean $cacheEnabled
|
||||
* @param bool $cacheEnabled
|
||||
*/
|
||||
public function setCacheEnabled( $cacheEnabled ) {
|
||||
$this->cacheHelper->setCacheEnabled( $cacheEnabled );
|
||||
|
|
@ -78,8 +78,8 @@ abstract class CachedAction extends FormlessAction implements ICacheHelper {
|
|||
*
|
||||
* @since 1.20
|
||||
*
|
||||
* @param integer|null $cacheExpiry Sets the cache expiry, either ttl in seconds or unix timestamp.
|
||||
* @param boolean|null $cacheEnabled Sets if the cache should be enabled or not.
|
||||
* @param int|null $cacheExpiry Sets the cache expiry, either ttl in seconds or unix timestamp.
|
||||
* @param bool|null $cacheEnabled Sets if the cache should be enabled or not.
|
||||
*/
|
||||
public function startCache( $cacheExpiry = null, $cacheEnabled = null ) {
|
||||
$this->cacheHelper = new CacheHelper();
|
||||
|
|
@ -153,7 +153,7 @@ abstract class CachedAction extends FormlessAction implements ICacheHelper {
|
|||
*
|
||||
* @since 1.20
|
||||
*
|
||||
* @param integer $cacheExpiry
|
||||
* @param int $cacheExpiry
|
||||
*/
|
||||
public function setExpiry( $cacheExpiry ) {
|
||||
$this->cacheHelper->setExpiry( $cacheExpiry );
|
||||
|
|
@ -179,7 +179,7 @@ abstract class CachedAction extends FormlessAction implements ICacheHelper {
|
|||
*
|
||||
* @since 1.20
|
||||
*
|
||||
* @param boolean $hasCached
|
||||
* @param bool $hasCached
|
||||
*/
|
||||
public function onCacheInitialized( $hasCached ) {
|
||||
if ( $hasCached ) {
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ class CreditsAction extends FormlessAction {
|
|||
/**
|
||||
* This is largely cadged from PageHistory::history
|
||||
*
|
||||
* @return String HTML
|
||||
* @return string HTML
|
||||
*/
|
||||
public function onView() {
|
||||
wfProfileIn( __METHOD__ );
|
||||
|
|
@ -58,9 +58,9 @@ class CreditsAction extends FormlessAction {
|
|||
/**
|
||||
* Get a list of contributors
|
||||
*
|
||||
* @param int $cnt maximum list of contributors to show
|
||||
* @param bool $showIfMax whether to contributors if there more than $cnt
|
||||
* @return String: html
|
||||
* @param int $cnt Maximum list of contributors to show
|
||||
* @param bool $showIfMax Whether to contributors if there more than $cnt
|
||||
* @return string html
|
||||
*/
|
||||
public function getCredits( $cnt, $showIfMax = true ) {
|
||||
wfProfileIn( __METHOD__ );
|
||||
|
|
@ -81,7 +81,7 @@ class CreditsAction extends FormlessAction {
|
|||
/**
|
||||
* Get the last author with the last modification time
|
||||
* @param Page $page
|
||||
* @return String HTML
|
||||
* @return string HTML
|
||||
*/
|
||||
protected function getAuthor( Page $page ) {
|
||||
$user = User::newFromName( $page->getUserText(), false );
|
||||
|
|
@ -102,9 +102,9 @@ class CreditsAction extends FormlessAction {
|
|||
|
||||
/**
|
||||
* Get a list of contributors of $article
|
||||
* @param int $cnt maximum list of contributors to show
|
||||
* @param bool $showIfMax whether to contributors if there more than $cnt
|
||||
* @return String: html
|
||||
* @param int $cnt Maximum list of contributors to show
|
||||
* @param bool $showIfMax Whether to contributors if there more than $cnt
|
||||
* @return string html
|
||||
*/
|
||||
protected function getContributors( $cnt, $showIfMax ) {
|
||||
global $wgHiddenPrefs;
|
||||
|
|
@ -188,8 +188,8 @@ class CreditsAction extends FormlessAction {
|
|||
|
||||
/**
|
||||
* Get a link to $user's user page
|
||||
* @param $user User object
|
||||
* @return String: html
|
||||
* @param User $user
|
||||
* @return string Html
|
||||
*/
|
||||
protected function link( User $user ) {
|
||||
global $wgHiddenPrefs;
|
||||
|
|
@ -208,8 +208,8 @@ class CreditsAction extends FormlessAction {
|
|||
|
||||
/**
|
||||
* Get a link to $user's user page
|
||||
* @param $user User object
|
||||
* @return String: html
|
||||
* @param User $user
|
||||
* @return string Html
|
||||
*/
|
||||
protected function userLink( User $user ) {
|
||||
$link = $this->link( $user );
|
||||
|
|
@ -227,7 +227,7 @@ class CreditsAction extends FormlessAction {
|
|||
|
||||
/**
|
||||
* Get a link to action=credits of $article page
|
||||
* @return String: HTML link
|
||||
* @return string HTML link
|
||||
*/
|
||||
protected function othersLink() {
|
||||
return Linker::linkKnown(
|
||||
|
|
|
|||
|
|
@ -30,13 +30,13 @@ abstract class FormAction extends Action {
|
|||
|
||||
/**
|
||||
* Get an HTMLForm descriptor array
|
||||
* @return Array
|
||||
* @return array
|
||||
*/
|
||||
abstract protected function getFormFields();
|
||||
|
||||
/**
|
||||
* Add pre- or post-text to the form
|
||||
* @return String HTML which will be sent to $form->addPreText()
|
||||
* @return string HTML which will be sent to $form->addPreText()
|
||||
*/
|
||||
protected function preText() {
|
||||
return '';
|
||||
|
|
@ -51,7 +51,7 @@ abstract class FormAction extends Action {
|
|||
|
||||
/**
|
||||
* Play with the HTMLForm if you need to more substantially
|
||||
* @param $form HTMLForm
|
||||
* @param HTMLForm $form
|
||||
*/
|
||||
protected function alterForm( HTMLForm $form ) {
|
||||
}
|
||||
|
|
@ -91,8 +91,8 @@ abstract class FormAction extends Action {
|
|||
* Process the form on POST submission. If you return false from getFormFields(),
|
||||
* this will obviously never be reached. If you don't want to do anything with the
|
||||
* form, just return false here
|
||||
* @param $data Array
|
||||
* @return Bool|Array true for success, false for didn't-try, array of errors on failure
|
||||
* @param array $data
|
||||
* @return bool|array True for success, false for didn't-try, array of errors on failure
|
||||
*/
|
||||
abstract public function onSubmit( $data );
|
||||
|
||||
|
|
@ -125,8 +125,8 @@ abstract class FormAction extends Action {
|
|||
/**
|
||||
* @see Action::execute()
|
||||
*
|
||||
* @param $data array|null
|
||||
* @param $captureErrors bool
|
||||
* @param array|null $data
|
||||
* @param bool $captureErrors
|
||||
* @throws ErrorPageError|Exception
|
||||
* @return bool
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ abstract class FormlessAction extends Action {
|
|||
|
||||
/**
|
||||
* Show something on GET request.
|
||||
* @return String|null will be added to the HTMLForm if present, or just added to the
|
||||
* @return string|null Will be added to the HTMLForm if present, or just added to the
|
||||
* output if not. Return null to not add anything
|
||||
*/
|
||||
abstract public function onView();
|
||||
|
|
@ -44,7 +44,7 @@ abstract class FormlessAction extends Action {
|
|||
}
|
||||
|
||||
/**
|
||||
* @param $data Array
|
||||
* @param array $data
|
||||
* @return bool
|
||||
*/
|
||||
public function onSubmit( $data ) {
|
||||
|
|
@ -70,10 +70,10 @@ abstract class FormlessAction extends Action {
|
|||
/**
|
||||
* Execute the action silently, not giving any output. Since these actions don't have
|
||||
* forms, they probably won't have any data, but some (eg rollback) may do
|
||||
* @param array $data values that would normally be in the GET request
|
||||
* @param bool $captureErrors whether to catch exceptions and just return false
|
||||
* @param array $data Values that would normally be in the GET request
|
||||
* @param bool $captureErrors Whether to catch exceptions and just return false
|
||||
* @throws ErrorPageError|Exception
|
||||
* @return Bool whether execution was successful
|
||||
* @return bool Whether execution was successful
|
||||
*/
|
||||
public function execute( array $data = null, $captureErrors = true ) {
|
||||
try {
|
||||
|
|
|
|||
|
|
@ -212,9 +212,9 @@ class HistoryAction extends FormlessAction {
|
|||
* direction. This is now only used by the feeds. It was previously
|
||||
* used by the main UI but that's now handled by the pager.
|
||||
*
|
||||
* @param $limit Integer: the limit number of revisions to get
|
||||
* @param $offset Integer
|
||||
* @param $direction Integer: either HistoryPage::DIR_PREV or HistoryPage::DIR_NEXT
|
||||
* @param int $limit The limit number of revisions to get
|
||||
* @param int $offset
|
||||
* @param int $direction Either HistoryPage::DIR_PREV or HistoryPage::DIR_NEXT
|
||||
* @return ResultWrapper
|
||||
*/
|
||||
function fetchRevisions( $limit, $offset, $direction ) {
|
||||
|
|
@ -303,7 +303,7 @@ class HistoryAction extends FormlessAction {
|
|||
* Borrows Recent Changes' feed generation functions for formatting;
|
||||
* includes a diff to the previous revision (if any).
|
||||
*
|
||||
* @param $row Object: database row
|
||||
* @param stdClass|array $row database row
|
||||
* @return FeedItem
|
||||
*/
|
||||
function feedItem( $row ) {
|
||||
|
|
@ -541,9 +541,9 @@ class HistoryPager extends ReverseChronologicalPager {
|
|||
/**
|
||||
* Creates a submit button
|
||||
*
|
||||
* @param string $message text of the submit button, will be escaped
|
||||
* @param array $attributes attributes
|
||||
* @return String: HTML output for the submit button
|
||||
* @param string $message Text of the submit button, will be escaped
|
||||
* @param array $attributes Attributes
|
||||
* @return string HTML output for the submit button
|
||||
*/
|
||||
function submitButton( $message, $attributes = array() ) {
|
||||
# Disable submit button if history has 1 revision only
|
||||
|
|
@ -726,8 +726,8 @@ class HistoryPager extends ReverseChronologicalPager {
|
|||
/**
|
||||
* Create a link to view this revision of the page
|
||||
*
|
||||
* @param $rev Revision
|
||||
* @return String
|
||||
* @param Revision $rev
|
||||
* @return string
|
||||
*/
|
||||
function revLink( $rev ) {
|
||||
$date = $this->getLanguage()->userTimeAndDate( $rev->getTimestamp(), $this->getUser() );
|
||||
|
|
@ -752,9 +752,9 @@ class HistoryPager extends ReverseChronologicalPager {
|
|||
/**
|
||||
* Create a diff-to-current link for this revision for this page
|
||||
*
|
||||
* @param $rev Revision
|
||||
* @param $latest Boolean: this is the latest revision of the page?
|
||||
* @return String
|
||||
* @param Revision $rev
|
||||
* @param bool $latest This is the latest revision of the page?
|
||||
* @return string
|
||||
*/
|
||||
function curLink( $rev, $latest ) {
|
||||
$cur = $this->historyPage->message['cur'];
|
||||
|
|
@ -776,9 +776,9 @@ class HistoryPager extends ReverseChronologicalPager {
|
|||
/**
|
||||
* Create a diff-to-previous link for this revision for this page.
|
||||
*
|
||||
* @param $prevRev Revision: the previous revision
|
||||
* @param $next Mixed: the newer revision
|
||||
* @return String
|
||||
* @param Revision $prevRev The previous revision
|
||||
* @param mixed $next The newer revision
|
||||
* @return string
|
||||
*/
|
||||
function lastLink( $prevRev, $next ) {
|
||||
$last = $this->historyPage->message['last'];
|
||||
|
|
@ -818,10 +818,10 @@ class HistoryPager extends ReverseChronologicalPager {
|
|||
/**
|
||||
* Create radio buttons for page history
|
||||
*
|
||||
* @param $rev Revision object
|
||||
* @param $firstInList Boolean: is this version the first one?
|
||||
* @param Revision $rev
|
||||
* @param bool $firstInList Is this version the first one?
|
||||
*
|
||||
* @return String: HTML output for the radio buttons
|
||||
* @return string HTML output for the radio buttons
|
||||
*/
|
||||
function diffButtons( $rev, $firstInList ) {
|
||||
if ( $this->getNumRows() > 1 ) {
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ class InfoAction extends FormlessAction {
|
|||
/**
|
||||
* Returns the name of the action this object responds to.
|
||||
*
|
||||
* @return string lowercase
|
||||
* @return string Lowercase name
|
||||
*/
|
||||
public function getName() {
|
||||
return 'info';
|
||||
|
|
@ -763,7 +763,7 @@ class InfoAction extends FormlessAction {
|
|||
|
||||
/**
|
||||
* Get a list of contributors of $article
|
||||
* @return string: html
|
||||
* @return string Html
|
||||
*/
|
||||
protected function getContributors() {
|
||||
global $wgHiddenPrefs;
|
||||
|
|
|
|||
|
|
@ -125,7 +125,7 @@ class RawAction extends FormlessAction {
|
|||
* Get the text that should be returned, or false if the page or revision
|
||||
* was not found.
|
||||
*
|
||||
* @return String|Bool
|
||||
* @return string|bool
|
||||
*/
|
||||
public function getRawText() {
|
||||
global $wgParser;
|
||||
|
|
@ -198,7 +198,7 @@ class RawAction extends FormlessAction {
|
|||
/**
|
||||
* Get the ID of the revision that should used to get the text.
|
||||
*
|
||||
* @return Integer
|
||||
* @return int
|
||||
*/
|
||||
public function getOldId() {
|
||||
$oldid = $this->getRequest()->getInt( 'oldid' );
|
||||
|
|
@ -230,7 +230,7 @@ class RawAction extends FormlessAction {
|
|||
/**
|
||||
* Get the content type to use for the response
|
||||
*
|
||||
* @return String
|
||||
* @return string
|
||||
*/
|
||||
public function getContentType() {
|
||||
$ctype = $this->getRequest()->getVal( 'ctype' );
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ class RedisConnectionPool {
|
|||
protected $password;
|
||||
/** @var bool Whether connections persist */
|
||||
protected $persistent;
|
||||
/** @var integer Serializer to use (Redis::SERIALIZER_*) */
|
||||
/** @var int Serializer to use (Redis::SERIALIZER_*) */
|
||||
protected $serializer;
|
||||
/** @} */
|
||||
|
||||
|
|
@ -408,7 +408,7 @@ class RedisConnRef {
|
|||
/**
|
||||
* @param string $script
|
||||
* @param array $params
|
||||
* @param integer $numKeys
|
||||
* @param int $numKeys
|
||||
* @return mixed
|
||||
* @throws RedisException
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -98,7 +98,7 @@ interface Content {
|
|||
*
|
||||
* @since 1.21
|
||||
*
|
||||
* @return String The model id
|
||||
* @return string The model id
|
||||
*/
|
||||
public function getModel();
|
||||
|
||||
|
|
@ -122,7 +122,7 @@ interface Content {
|
|||
*
|
||||
* @since 1.21
|
||||
*
|
||||
* @return String
|
||||
* @return string
|
||||
*/
|
||||
public function getDefaultFormat();
|
||||
|
||||
|
|
@ -232,7 +232,7 @@ interface Content {
|
|||
*
|
||||
* @since 1.21
|
||||
*
|
||||
* @return Content. A copy of this object
|
||||
* @return Content A copy of this object
|
||||
*/
|
||||
public function copy();
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
*/
|
||||
abstract class DBAccessBase implements IDBAccessObject {
|
||||
/**
|
||||
* @var String|bool $wiki The target wiki's name. This must be an ID
|
||||
* @var string|bool $wiki The target wiki's name. This must be an ID
|
||||
* that LBFactory can understand.
|
||||
*/
|
||||
protected $wiki = false;
|
||||
|
|
@ -68,7 +68,7 @@ abstract class DBAccessBase implements IDBAccessObject {
|
|||
*
|
||||
* @since 1.21
|
||||
*
|
||||
* @param DatabaseBase $db the database connection to release.
|
||||
* @param DatabaseBase $db The database connection to release.
|
||||
*/
|
||||
protected function releaseConnection( DatabaseBase $db ) {
|
||||
if ( $this->wiki !== false ) {
|
||||
|
|
|
|||
Loading…
Reference in a new issue