From: Timo Tijhof <krinklemail@gmail.com>
Date: Wed, 19 Apr 2017 22:27:41 +0000 (-0700)
Subject: ReadOnlyMode: Add a few doc blocks
X-Git-Tag: 1.31.0-rc.0~3464
X-Git-Url: http://git.cyclocoop.org//%22%22.str_replace%28%27%22%27%2C?a=commitdiff_plain;h=3c620b07ab0eebe2ddd1ae8e2be501734cb6cab3;p=lhc%2Fweb%2Fwiklou.git

ReadOnlyMode: Add a few doc blocks

Follows-up 820f46964f7968a.

Change-Id: I7866eb7c8bb9c45a24a3c567a7befe3505821873
---

diff --git a/includes/MediaWikiServices.php b/includes/MediaWikiServices.php
index d84a2b9f3b..3bf6d78c86 100644
--- a/includes/MediaWikiServices.php
+++ b/includes/MediaWikiServices.php
@@ -658,7 +658,7 @@ class MediaWikiServices extends ServiceContainer {
 
 	/**
 	 * @since 1.29
-	 * @return \ReadOnlyMode
+	 * @return \ConfiguredReadOnlyMode
 	 */
 	public function getConfiguredReadOnlyMode() {
 		return $this->getService( 'ConfiguredReadOnlyMode' );
diff --git a/includes/ReadOnlyMode.php b/includes/ReadOnlyMode.php
index 044e3f51a8..592d495868 100644
--- a/includes/ReadOnlyMode.php
+++ b/includes/ReadOnlyMode.php
@@ -9,7 +9,10 @@ use Wikimedia\Rdbms\LoadBalancer;
  * @since 1.29
  */
 class ReadOnlyMode {
+	/** @var ConfiguredReadOnlyMode */
 	private $configuredReadOnly;
+
+	/** @var LoadBalancer */
 	private $loadBalancer;
 
 	public function __construct( ConfiguredReadOnlyMode $cro, LoadBalancer $loadBalancer ) {
@@ -49,6 +52,8 @@ class ReadOnlyMode {
 	/**
 	 * Set the read-only mode, which will apply for the remainder of the
 	 * request or until a service reset.
+	 *
+	 * @param string|null $msg
 	 */
 	public function setReason( $msg ) {
 		$this->configuredReadOnly->setReason( $msg );
@@ -69,8 +74,13 @@ class ReadOnlyMode {
  * @since 1.29
  */
 class ConfiguredReadOnlyMode {
+	/** @var Config */
 	private $config;
+
+	/** @var string|bool|null */
 	private $fileReason;
+
+	/** @var string|null */
 	private $overrideReason;
 
 	public function __construct( Config $config ) {
@@ -114,6 +124,8 @@ class ConfiguredReadOnlyMode {
 	/**
 	 * Set the read-only mode, which will apply for the remainder of the
 	 * request or until a service reset.
+	 *
+	 * @param string|null $msg
 	 */
 	public function setReason( $msg ) {
 		$this->overrideReason = $msg;