[MediaWiki-commits] [Gerrit] mediawiki...Newsletter[master]: Cleanup and unify class level PHPDoc blocks
jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/400580 )
Change subject: Cleanup and unify class level PHPDoc blocks
..
Cleanup and unify class level PHPDoc blocks
This unifies certain minor details of the coding style across this
code base. This patch is pretty much exclusively about comments and
should not have any effect on production.
Change-Id: Ic96e60b85503a808f9c55a1efc663c95d413b1fc
---
M NewsletterHooks.php
M includes/Echo/BaseNewsletterPresentationModel.php
M includes/Echo/EchoNewsletterPresentationModel.php
M includes/Echo/EchoNewsletterPublisherAddedPresentationModel.php
M includes/Echo/EchoNewsletterSubscribedPresentationModel.php
M includes/Echo/EchoNewsletterUnsubscribedPresentationModel.php
M includes/Echo/EchoNewsletterUserLocator.php
M includes/Newsletter.php
M includes/NewsletterValidator.php
M includes/api/ApiNewsletterSubscribe.php
M includes/content/NewsletterContent.php
M includes/content/NewsletterContentHandler.php
M includes/content/NewsletterDataUpdate.php
M includes/content/NewsletterDiffEngine.php
M includes/logging/NewsletterLogFormatter.php
M includes/specials/SpecialNewsletter.php
M includes/specials/SpecialNewsletterCreate.php
M includes/specials/SpecialNewsletters.php
M includes/specials/pagers/NewsletterTablePager.php
M maintenance/deleteInactiveNewsletters.php
M maintenance/updateSubscribersCount.php
R tests/api/ApiNewsletterSubscribeTest.php
M tests/specials/SpecialNewsletterCreateTest.php
M tests/specials/SpecialNewslettersTest.php
24 files changed, 50 insertions(+), 20 deletions(-)
Approvals:
01tonythomas: Looks good to me, approved
jenkins-bot: Verified
diff --git a/NewsletterHooks.php b/NewsletterHooks.php
index de9205c..2e1112d 100644
--- a/NewsletterHooks.php
+++ b/NewsletterHooks.php
@@ -8,8 +8,8 @@
/**
* Function to be called before EchoEvent
*
-* @param array &$notifications Echo notifications
-* @param array &$notificationCategories Echo notification categories
+* @param array[] &$notifications Echo notifications
+* @param array[] &$notificationCategories Echo notification categories
* @return bool
*/
public static function onBeforeCreateEchoEvent( &$notifications,
&$notificationCategories ) {
@@ -394,4 +394,5 @@
return true;
}
+
}
diff --git a/includes/Echo/BaseNewsletterPresentationModel.php
b/includes/Echo/BaseNewsletterPresentationModel.php
index 40f8da9..50f7ddd 100644
--- a/includes/Echo/BaseNewsletterPresentationModel.php
+++ b/includes/Echo/BaseNewsletterPresentationModel.php
@@ -1,6 +1,7 @@
getNewsletterId() );
return (bool)$nl;
@@ -27,4 +28,5 @@
}
return $result;
}
+
}
diff --git a/includes/Echo/EchoNewsletterPresentationModel.php
b/includes/Echo/EchoNewsletterPresentationModel.php
index b7ed667..425f933 100644
--- a/includes/Echo/EchoNewsletterPresentationModel.php
+++ b/includes/Echo/EchoNewsletterPresentationModel.php
@@ -42,4 +42,5 @@
return $this->msg( 'notification-body-newsletter-announce' )
->params( $this->event->getExtraParam( 'section-text' )
);
}
+
}
diff --git a/includes/Echo/EchoNewsletterPublisherAddedPresentationModel.php
b/includes/Echo/EchoNewsletterPublisherAddedPresentationModel.php
index f20d5e5..1c83b5b 100644
--- a/includes/Echo/EchoNewsletterPublisherAddedPresentationModel.php
+++ b/includes/Echo/EchoNewsletterPublisherAddedPresentationModel.php
@@ -21,4 +21,5 @@
$msg->params( $agentGenderName );
return $msg;
}
+
}
diff --git a/includes/Echo/EchoNewsletterSubscribedPresentationModel.php
b/includes/Echo/EchoNewsletterSubscribedPresentationModel.php
index 3a9ff32..9a2cf7d 100644
--- a/includes/Echo/EchoNewsletterSubscribedPresentationModel.php
+++ b/includes/Echo/EchoNewsletterSubscribedPresentationModel.php
@@ -20,4 +20,5 @@
$msg->params( $this->getNewsletterName() );
return $msg;
}
+
}
diff --git a/includes/Echo/EchoNewsletterUnsubscribedPresentationModel.php
b/includes/Echo/EchoNewsletterUnsubscribedPresentationModel.php
index b050aa5..c50c880 100644
--- a/includes/Echo/EchoNewsletterUnsubscribedPresentationModel.php
+++ b/includes/Echo/EchoNewsletterUnsubscribedPresentationModel.php
@@ -20,4 +20,5 @@
$msg->params( $this->getNewsletterName() );
return $msg;
}
+
}
diff --git a/includes/Echo/EchoNewsletterUserLocator.php
b/includes/Echo/EchoNewsletterUserLocator.php
index f674bc7..023ca47 100644
--- a/includes/Echo/EchoNewsletterUserLocator.php
+++ b/includes/Echo/EchoNewsletterUserLocator.php
@@ -1,6 +1,7 @@
getSubscribers() );
}
+
}
diff --git a/includes/Newsletter.php b/includes/Newsletter.php
index 46a5753..5fbf290 100644
--- a/includes/Newsletter.ph
[MediaWiki-commits] [Gerrit] mediawiki...Newsletter[master]: Cleanup and unify class level PHPDoc blocks
Thiemo Kreuz (WMDE) has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/400580 )
Change subject: Cleanup and unify class level PHPDoc blocks
..
Cleanup and unify class level PHPDoc blocks
This unifies certain minor details of the coding style across this
code base. This patch is pretty much exclusively about comments and
should not have any effect on production.
Change-Id: Ic96e60b85503a808f9c55a1efc663c95d413b1fc
---
M NewsletterHooks.php
M includes/Echo/BaseNewsletterPresentationModel.php
M includes/Echo/EchoNewsletterPresentationModel.php
M includes/Echo/EchoNewsletterPublisherAddedPresentationModel.php
M includes/Echo/EchoNewsletterSubscribedPresentationModel.php
M includes/Echo/EchoNewsletterUnsubscribedPresentationModel.php
M includes/Echo/EchoNewsletterUserLocator.php
M includes/Newsletter.php
M includes/NewsletterValidator.php
M includes/api/ApiNewsletterSubscribe.php
M includes/content/NewsletterContent.php
M includes/content/NewsletterContentHandler.php
M includes/content/NewsletterDataUpdate.php
M includes/content/NewsletterDiffEngine.php
M includes/logging/NewsletterLogFormatter.php
M includes/specials/SpecialNewsletter.php
M includes/specials/SpecialNewsletterCreate.php
M includes/specials/SpecialNewsletters.php
M includes/specials/pagers/NewsletterTablePager.php
M maintenance/deleteInactiveNewsletters.php
M maintenance/updateSubscribersCount.php
R tests/api/ApiNewsletterSubscribeTest.php
M tests/specials/SpecialNewsletterCreateTest.php
M tests/specials/SpecialNewslettersTest.php
24 files changed, 52 insertions(+), 20 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Newsletter
refs/changes/80/400580/1
diff --git a/NewsletterHooks.php b/NewsletterHooks.php
index de9205c..2e1112d 100644
--- a/NewsletterHooks.php
+++ b/NewsletterHooks.php
@@ -8,8 +8,8 @@
/**
* Function to be called before EchoEvent
*
-* @param array &$notifications Echo notifications
-* @param array &$notificationCategories Echo notification categories
+* @param array[] &$notifications Echo notifications
+* @param array[] &$notificationCategories Echo notification categories
* @return bool
*/
public static function onBeforeCreateEchoEvent( &$notifications,
&$notificationCategories ) {
@@ -394,4 +394,5 @@
return true;
}
+
}
diff --git a/includes/Echo/BaseNewsletterPresentationModel.php
b/includes/Echo/BaseNewsletterPresentationModel.php
index 40f8da9..50f7ddd 100644
--- a/includes/Echo/BaseNewsletterPresentationModel.php
+++ b/includes/Echo/BaseNewsletterPresentationModel.php
@@ -1,6 +1,7 @@
getNewsletterId() );
return (bool)$nl;
@@ -27,4 +28,5 @@
}
return $result;
}
+
}
diff --git a/includes/Echo/EchoNewsletterPresentationModel.php
b/includes/Echo/EchoNewsletterPresentationModel.php
index b7ed667..425f933 100644
--- a/includes/Echo/EchoNewsletterPresentationModel.php
+++ b/includes/Echo/EchoNewsletterPresentationModel.php
@@ -42,4 +42,5 @@
return $this->msg( 'notification-body-newsletter-announce' )
->params( $this->event->getExtraParam( 'section-text' )
);
}
+
}
diff --git a/includes/Echo/EchoNewsletterPublisherAddedPresentationModel.php
b/includes/Echo/EchoNewsletterPublisherAddedPresentationModel.php
index f20d5e5..1c83b5b 100644
--- a/includes/Echo/EchoNewsletterPublisherAddedPresentationModel.php
+++ b/includes/Echo/EchoNewsletterPublisherAddedPresentationModel.php
@@ -21,4 +21,5 @@
$msg->params( $agentGenderName );
return $msg;
}
+
}
diff --git a/includes/Echo/EchoNewsletterSubscribedPresentationModel.php
b/includes/Echo/EchoNewsletterSubscribedPresentationModel.php
index 3a9ff32..9a2cf7d 100644
--- a/includes/Echo/EchoNewsletterSubscribedPresentationModel.php
+++ b/includes/Echo/EchoNewsletterSubscribedPresentationModel.php
@@ -20,4 +20,5 @@
$msg->params( $this->getNewsletterName() );
return $msg;
}
+
}
diff --git a/includes/Echo/EchoNewsletterUnsubscribedPresentationModel.php
b/includes/Echo/EchoNewsletterUnsubscribedPresentationModel.php
index b050aa5..c50c880 100644
--- a/includes/Echo/EchoNewsletterUnsubscribedPresentationModel.php
+++ b/includes/Echo/EchoNewsletterUnsubscribedPresentationModel.php
@@ -20,4 +20,5 @@
$msg->params( $this->getNewsletterName() );
return $msg;
}
+
}
diff --git a/includes/Echo/EchoNewsletterUserLocator.php
b/includes/Echo/EchoNewsletterUserLocator.php
index f674bc7..023ca47 100644
--- a/includes/Echo/EchoNewsletterUserLocator.php
+++ b/includes/Echo/EchoNewsletterUserLocator.php
@@ -1,6 +1,7 @@
getSubscribers() );
}
+
}
diff --git a/includes/Newsletter.php b/includes/Newsletter.php
index 46a5753..5fbf290 100644
--- a
