jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/349110 )
Change subject: ReadOnlyMode: Add a few doc blocks
......................................................................
ReadOnlyMode: Add a few doc blocks
Follows-up 820f46964f7968a.
Change-Id: I7866eb7c8bb9c45a24a3c567a7befe3505821873
---
M includes/MediaWikiServices.php
M includes/ReadOnlyMode.php
2 files changed, 13 insertions(+), 1 deletion(-)
Approvals:
Aaron Schulz: Looks good to me, approved
jenkins-bot: Verified
diff --git a/includes/MediaWikiServices.php b/includes/MediaWikiServices.php
index d84a2b9..3bf6d78 100644
--- a/includes/MediaWikiServices.php
+++ b/includes/MediaWikiServices.php
@@ -658,7 +658,7 @@
/**
* @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 044e3f5..592d495 100644
--- a/includes/ReadOnlyMode.php
+++ b/includes/ReadOnlyMode.php
@@ -9,7 +9,10 @@
* @since 1.29
*/
class ReadOnlyMode {
+ /** @var ConfiguredReadOnlyMode */
private $configuredReadOnly;
+
+ /** @var LoadBalancer */
private $loadBalancer;
public function __construct( ConfiguredReadOnlyMode $cro, LoadBalancer
$loadBalancer ) {
@@ -49,6 +52,8 @@
/**
* 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 @@
* @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 @@
/**
* 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;
--
To view, visit https://gerrit.wikimedia.org/r/349110
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I7866eb7c8bb9c45a24a3c567a7befe3505821873
Gerrit-PatchSet: 3
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Krinkle <krinklem...@gmail.com>
Gerrit-Reviewer: Aaron Schulz <asch...@wikimedia.org>
Gerrit-Reviewer: Tim Starling <tstarl...@wikimedia.org>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
