From f741f6c09266b41efc716975464b7c445b99699a Mon Sep 17 00:00:00 2001 From: Siebrand Mazeland Date: Fri, 11 Jan 2013 16:56:04 +0100 Subject: [PATCH] Update doc comments and code formatting. Change-Id: I1896d7b1ab5d11d3a609fd97db7c503ad6c590e5 --- includes/context/ContextSource.php | 9 +++--- includes/context/DerivativeContext.php | 23 +++++++--------- includes/context/IContextSource.php | 6 ++-- includes/context/RequestContext.php | 38 ++++++++++++-------------- 4 files changed, 34 insertions(+), 42 deletions(-) diff --git a/includes/context/ContextSource.php b/includes/context/ContextSource.php index d5a6d15ad9..4a02f0b0cc 100644 --- a/includes/context/ContextSource.php +++ b/includes/context/ContextSource.php @@ -28,7 +28,6 @@ * member variable and provide accessors to it. */ abstract class ContextSource implements IContextSource { - /** * @var IContextSource */ @@ -42,7 +41,7 @@ abstract class ContextSource implements IContextSource { public function getContext() { if ( $this->context === null ) { $class = get_class( $this ); - wfDebug( __METHOD__ . " ($class): called and \$context is null. Using RequestContext::getMain() for sanity\n" ); + wfDebug( __METHOD__ . " ($class): called and \$context is null. Using RequestContext::getMain() for sanity\n" ); $this->context = RequestContext::getMain(); } return $this->context; @@ -52,7 +51,7 @@ abstract class ContextSource implements IContextSource { * Set the IContextSource object * * @since 1.18 - * @param $context IContextSource + * @param IContextSource $context */ public function setContext( IContextSource $context ) { $this->context = $context; @@ -107,7 +106,7 @@ abstract class ContextSource implements IContextSource { * Get the OutputPage object * * @since 1.18 - * @return OutputPage object + * @return OutputPage */ public function getOutput() { return $this->getContext()->getOutput(); @@ -159,7 +158,7 @@ abstract class ContextSource implements IContextSource { * Parameters are the same as wfMessage() * * @since 1.18 - * @return Message object + * @return Message */ public function msg( /* $args */ ) { $args = func_get_args(); diff --git a/includes/context/DerivativeContext.php b/includes/context/DerivativeContext.php index a4e327267f..b9a7006865 100644 --- a/includes/context/DerivativeContext.php +++ b/includes/context/DerivativeContext.php @@ -30,7 +30,6 @@ * a different Title instance set on it. */ class DerivativeContext extends ContextSource { - /** * @var WebRequest */ @@ -68,7 +67,7 @@ class DerivativeContext extends ContextSource { /** * Constructor - * @param $context IContextSource Context to inherit from + * @param IContextSource $context Context to inherit from */ public function __construct( IContextSource $context ) { $this->setContext( $context ); @@ -77,7 +76,7 @@ class DerivativeContext extends ContextSource { /** * Set the WebRequest object * - * @param $r WebRequest object + * @param WebRequest $r */ public function setRequest( WebRequest $r ) { $this->request = $r; @@ -99,7 +98,7 @@ class DerivativeContext extends ContextSource { /** * Set the Title object * - * @param $t Title object + * @param Title $t */ public function setTitle( Title $t ) { $this->title = $t; @@ -140,7 +139,7 @@ class DerivativeContext extends ContextSource { * Set the WikiPage object * * @since 1.19 - * @param $p WikiPage object + * @param WikiPage $p */ public function setWikiPage( WikiPage $p ) { $this->wikipage = $p; @@ -166,7 +165,7 @@ class DerivativeContext extends ContextSource { /** * Set the OutputPage object * - * @param $o OutputPage + * @param OutputPage $o */ public function setOutput( OutputPage $o ) { $this->output = $o; @@ -175,7 +174,7 @@ class DerivativeContext extends ContextSource { /** * Get the OutputPage object * - * @return OutputPage object + * @return OutputPage */ public function getOutput() { if ( !is_null( $this->output ) ) { @@ -188,7 +187,7 @@ class DerivativeContext extends ContextSource { /** * Set the User object * - * @param $u User + * @param User $u */ public function setUser( User $u ) { $this->user = $u; @@ -211,7 +210,7 @@ class DerivativeContext extends ContextSource { * Set the Language object * * @deprecated 1.19 Use setLanguage instead - * @param $l Mixed Language instance or language code + * @param Language|string $l Language instance or language code */ public function setLang( $l ) { wfDeprecated( __METHOD__, '1.19' ); @@ -221,7 +220,7 @@ class DerivativeContext extends ContextSource { /** * Set the Language object * - * @param $l Mixed Language instance or language code + * @param Language|string $l Language instance or language code * @throws MWException * @since 1.19 */ @@ -263,7 +262,7 @@ class DerivativeContext extends ContextSource { /** * Set the Skin object * - * @param $s Skin + * @param Skin $s */ public function setSkin( Skin $s ) { $this->skin = clone $s; @@ -282,6 +281,4 @@ class DerivativeContext extends ContextSource { return $this->getContext()->getSkin(); } } - } - diff --git a/includes/context/IContextSource.php b/includes/context/IContextSource.php index 476035b525..0399081cfa 100644 --- a/includes/context/IContextSource.php +++ b/includes/context/IContextSource.php @@ -27,7 +27,6 @@ * Interface for objects which can provide a context on request. */ interface IContextSource { - /** * Get the WebRequest object * @@ -66,7 +65,7 @@ interface IContextSource { /** * Get the OutputPage object * - * @return OutputPage object + * @return OutputPage */ public function getOutput(); @@ -103,8 +102,7 @@ interface IContextSource { /** * Get a Message object with context set * - * @return Message object + * @return Message */ public function msg(); } - diff --git a/includes/context/RequestContext.php b/includes/context/RequestContext.php index e4de030c74..c1ce7515a4 100644 --- a/includes/context/RequestContext.php +++ b/includes/context/RequestContext.php @@ -28,7 +28,6 @@ * Group all the pieces relevant to the context of a request into one instance */ class RequestContext implements IContextSource { - /** * @var WebRequest */ @@ -67,7 +66,7 @@ class RequestContext implements IContextSource { /** * Set the WebRequest object * - * @param $r WebRequest object + * @param WebRequest $r */ public function setRequest( WebRequest $r ) { $this->request = $r; @@ -89,7 +88,7 @@ class RequestContext implements IContextSource { /** * Set the Title object * - * @param $t Title object + * @param Title $t */ public function setTitle( Title $t ) { $this->title = $t; @@ -137,7 +136,7 @@ class RequestContext implements IContextSource { * Set the WikiPage object * * @since 1.19 - * @param $p WikiPage object + * @param WikiPage $p */ public function setWikiPage( WikiPage $p ) { $contextTitle = $this->getTitle(); @@ -180,7 +179,7 @@ class RequestContext implements IContextSource { /** * Get the OutputPage object * - * @return OutputPage object + * @return OutputPage */ public function getOutput() { if ( $this->output === null ) { @@ -192,7 +191,7 @@ class RequestContext implements IContextSource { /** * Set the User object * - * @param $u User + * @param User $u */ public function setUser( User $u ) { $this->user = $u; @@ -213,7 +212,7 @@ class RequestContext implements IContextSource { /** * Accepts a language code and ensures it's sane. Outputs a cleaned up language * code and replaces with $wgLanguageCode if not sane. - * @param $code string + * @param string $code Language code * @return string */ public static function sanitizeLangCode( $code ) { @@ -223,7 +222,7 @@ class RequestContext implements IContextSource { $code = strtolower( $code ); # Validate $code - if( empty( $code ) || !Language::isValidCode( $code ) || ( $code === 'qqq' ) ) { + if ( empty( $code ) || !Language::isValidCode( $code ) || ( $code === 'qqq' ) ) { wfDebug( "Invalid user language code\n" ); $code = $wgLanguageCode; } @@ -235,7 +234,7 @@ class RequestContext implements IContextSource { * Set the Language object * * @deprecated 1.19 Use setLanguage instead - * @param $l Mixed Language instance or language code + * @param Language|string $l Language instance or language code */ public function setLang( $l ) { wfDeprecated( __METHOD__, '1.19' ); @@ -245,7 +244,7 @@ class RequestContext implements IContextSource { /** * Set the Language object * - * @param $l Mixed Language instance or language code + * @param Language|string $l Language instance or language code * @throws MWException * @since 1.19 */ @@ -287,7 +286,7 @@ class RequestContext implements IContextSource { wfRunHooks( 'UserGetLanguageObject', array( $this->getUser(), &$code ) ); - if( $code === $wgLanguageCode ) { + if ( $code === $wgLanguageCode ) { $this->lang = $wgContLang; } else { $obj = Language::factory( $code ); @@ -300,7 +299,7 @@ class RequestContext implements IContextSource { /** * Set the Skin object * - * @param $s Skin + * @param Skin $s */ public function setSkin( Skin $s ) { $this->skin = clone $s; @@ -322,7 +321,7 @@ class RequestContext implements IContextSource { // If the hook worked try to set a skin from it if ( $skin instanceof Skin ) { $this->skin = $skin; - } elseif ( is_string($skin) ) { + } elseif ( is_string( $skin ) ) { $this->skin = Skin::newFromKey( $skin ); } @@ -330,7 +329,7 @@ class RequestContext implements IContextSource { // then go through the normal processing to load a skin if ( $this->skin === null ) { global $wgHiddenPrefs; - if( !in_array( 'skin', $wgHiddenPrefs ) ) { + if ( !in_array( 'skin', $wgHiddenPrefs ) ) { # get the user skin $userSkin = $this->getUser()->getOption( 'skin' ); $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin ); @@ -356,7 +355,7 @@ class RequestContext implements IContextSource { * Get a Message object with context set * Parameters are the same as wfMessage() * - * @return Message object + * @return Message */ public function msg() { $args = func_get_args(); @@ -368,7 +367,7 @@ class RequestContext implements IContextSource { /** * Get the RequestContext object associated with the main request * - * @return RequestContext object + * @return RequestContext */ public static function getMain() { static $instance = null; @@ -388,11 +387,11 @@ class RequestContext implements IContextSource { * language or a uselang param in the fauxrequest data may change the lang * - Skin will be based on the anonymous user, should be the wiki's default skin * - * @param $title Title Title to use for the extraneous request - * @param $request Mixed A WebRequest or data to use for a FauxRequest + * @param Title $title Title to use for the extraneous request + * @param mixed $request A WebRequest or data to use for a FauxRequest * @return RequestContext */ - public static function newExtraneousContext( Title $title, $request=array() ) { + public static function newExtraneousContext( Title $title, $request = array() ) { $context = new self; $context->setTitle( $title ); if ( $request instanceof WebRequest ) { @@ -403,5 +402,4 @@ class RequestContext implements IContextSource { $context->user = User::newFromName( '127.0.0.1', false ); return $context; } - } -- 2.20.1