/**
* 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;
/**
* Set the HTTP status code to send with the output.
*
- * @param $statusCode Integer
+ * @param int $statusCode
*/
public function setStatusCode( $statusCode ) {
$this->mStatusCode = $statusCode;
/**
* 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
/**
* Get all styles added by extensions
*
- * @return Array
+ * @return array
*/
function getExtStyle() {
return $this->mExtStyles;
/**
* Get all registered JS and CSS tags for the header.
*
- * @return String
+ * @return string
*/
function getScript() {
return $this->mScripts . $this->getHeadItems();
/**
* 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();
/**
* 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 ) );
/**
* 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' );
/**
* 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' );
/**
* 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' );
/**
* 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;
/**
* Get an array of head items
*
- * @return Array
+ * @return array
*/
function getHeadItemsArray() {
return $this->mHeadItems;
/**
* Get all header items in a string
*
- * @return String
+ * @return string
*/
function getHeadItems() {
$s = '';
/**
* 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] );
/**
* Return whether the output will contain only the body of the article
*
- * @return Boolean
+ * @return bool
*/
public function getArticleBodyOnly() {
return $this->mArticleBodyOnly;
/**
* Get the value of the "action text"
*
- * @return String
+ * @return string
*/
public function getPageTitleActionText() {
if ( isset( $this->mPageTitleActionText ) ) {
* "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 ) {
/**
* Return the "HTML title", i.e. the content of the "<title>" tag.
*
- * @return String
+ * @return string
*/
public function getHTMLTitle() {
return $this->mHTMLtitle;
/**
* 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;
* 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 ) {
/**
* Return the "page title", i.e. the content of the \<h1\> tag.
*
- * @return String
+ * @return string
*/
public function getPageTitle() {
return $this->mPagetitle;
/**
* Set the Title object to use
*
- * @param $t Title object
+ * @param Title $t
*/
public function setTitle( Title $t ) {
$this->getContext()->setTitle( $t );
/**
* 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();
/**
* Get the subtitle
*
- * @return String
+ * @return string
*/
public function getSubtitle() {
return implode( "<br />\n\t\t\t\t", $this->mSubtitle );
/**
* Return whether the page is "printable"
*
- * @return Boolean
+ * @return bool
*/
public function isPrintable() {
return $this->mPrintable;
/**
* Return whether the output will be completely disabled
*
- * @return Boolean
+ * @return bool
*/
public function isDisabled() {
return $this->mDoNothing;
/**
* Show an "add new section" link?
*
- * @return Boolean
+ * @return bool
*/
public function showNewSectionLink() {
return $this->mNewSectionLink;
/**
* Forcibly hide the new section link?
*
- * @return Boolean
+ * @return bool
*/
public function forceHideNewSectionLink() {
return $this->mHideNewSectionLink;
/**
* Should we output feed links for this page?
- * @return Boolean
+ * @return bool
*/
public function isSyndicated() {
return count( $this->mFeedLinks ) > 0;
* 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;
* 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;
* 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;
/**
* Return whether this page is related an article on the wiki
*
- * @return Boolean
+ * @return bool
*/
public function isArticleRelated() {
return $this->mIsArticleRelated;
/**
* 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;
* hidden categories) and $link a HTML fragment with a link to the category
* page
*
- * @return Array
+ * @return array
*/
public function getCategoryLinks() {
return $this->mCategoryLinks;
/**
* 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;
* 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' );
* 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 ) {
/**
* 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;
/**
* 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 );
*
* @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 ) );
/**
* 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 ) {
/**
* Get the displayed revision ID
*
- * @return Integer
+ * @return int
*/
public function getRevisionId() {
return $this->mRevisionId;
* 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;
/**
* 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;
/**
* Get the templates used on this page
*
- * @return Array (namespace => dbKey => revId)
+ * @return array (namespace => dbKey => revId)
* @since 1.18
*/
public function getTemplateIds() {
/**
* 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() {
/**
* Add a ParserOutput object, but without Html
*
- * @param $parserOutput ParserOutput object
+ * @param ParserOutput $parserOutput
*/
public function addParserOutputNoText( &$parserOutput ) {
$this->mLanguageLinks += $parserOutput->getLanguageLinks();
/**
* Add a ParserOutput object
*
- * @param $parserOutput ParserOutput
+ * @param ParserOutput $parserOutput
*/
function addParserOutput( &$parserOutput ) {
$this->addParserOutputNoText( $parserOutput );
/**
* Add the output of a QuickTemplate to the output buffer
*
- * @param $template QuickTemplate
+ * @param QuickTemplate $template
*/
public function addTemplate( &$template ) {
$this->addHTML( $template->getHTML() );
/**
* 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.
/**
* Use enableClientCache(false) to force it to send nocache headers
*
- * @param $state bool
+ * @param bool $state
*
* @return bool
*/
/**
* Get the list of cookies that will influence on the cache
*
- * @return Array
+ * @return array
*/
function getCacheVaryCookies() {
global $wgCookiePrefix, $wgCacheVaryCookies;
* 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' );
* 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?
*/
* 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 ) );
/**
* Get a complete X-Vary-Options header
*
- * @return String
+ * @return string
*/
public function getXVO() {
$cvCookies = $this->getCacheVaryCookies();
* 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;
/**
* 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(
* 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 ) {
* 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 ) {
* 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 ) {
/**
* 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() {
}
/**
- * 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 ) ) {
}
/**
- * @return Array
+ * @return array
*/
public function buildCssLinksArray() {
$links = array();
* 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() );
*
* 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();
/**
* 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 ) {
/**
* 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 ) {
* $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;
/**
* 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;
* 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();
*
* 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 ) {
/**
* 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;
* 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
*/
/**
* Whether this action requires the wiki not to be locked
- * @return Bool
+ * @return bool
*/
public function requiresWrite() {
return true;
/**
* Whether this action can still be executed by a blocked user
- * @return Bool
+ * @return bool
*/
public function requiresUnblock() {
return true;
/**
* Returns the name that goes in the \<h1\> page title
*
- * @return String
+ * @return string
*/
protected function getPageTitle() {
return $this->getTitle()->getPrefixedText();
/**
* Returns the description that goes below the \<h1\> tag
*
- * @return String
+ * @return string
*/
protected function getDescription() {
return $this->msg( strtolower( $this->getName() ) )->escaped();
/**
* 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();
}
dépôts / lhc / web / wiklou.git / commitdiff