01tonythomas has uploaded a new change for review.
https://gerrit.wikimedia.org/r/149912
Change subject: Add documentation to class constructors
......................................................................
Add documentation to class constructors
Change-Id: Iec0016d0dce41bf9fc325aa9d605e66ee612f1b5
---
M BounceHandlerActions.php
M ProcessUnRecognizedBounces.php
2 files changed, 9 insertions(+), 1 deletion(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/BounceHandler
refs/changes/12/149912/1
diff --git a/BounceHandlerActions.php b/BounceHandlerActions.php
index 73ce61c..3dde4e1 100644
--- a/BounceHandlerActions.php
+++ b/BounceHandlerActions.php
@@ -19,12 +19,16 @@
*/
protected $bounceRecordLimit;
+ /**
+ * @param string $wikiId The database id of the failing recipient
+ * @param int $bounceRecordPeriod Time period for which bounce
activities are considered before un-subscribing
+ * @param int $bounceRecordLimit The number of bounce allowed in the
bounceRecordPeriod.
+ */
public function __construct( $wikiId, $bounceRecordPeriod,
$bounceRecordLimit ) {
$this->wikiId = $wikiId;
$this->bounceRecordPeriod = $bounceRecordPeriod;
$this->bounceRecordLimit = $bounceRecordLimit;
}
-
/**
* Perform actions on users who failed to receive emails in a given
period
*
diff --git a/ProcessUnRecognizedBounces.php b/ProcessUnRecognizedBounces.php
index 55ed5c5..34f0889 100644
--- a/ProcessUnRecognizedBounces.php
+++ b/ProcessUnRecognizedBounces.php
@@ -10,6 +10,10 @@
*/
protected $unrecognizedBounceNotify;
+ /**
+ * @param array $unrecognizedBounceNotify The array of admins to be
notified on a bounce parse failure
+ * @param string $passwordSender The default email Return path address
+ */
public function __construct( $unrecognizedBounceNotify, $passwordSender
) {
$this->unrecognizedBounceNotify = $unrecognizedBounceNotify;
$this->passwordSender = $passwordSender;
--
To view, visit https://gerrit.wikimedia.org/r/149912
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Iec0016d0dce41bf9fc325aa9d605e66ee612f1b5
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/BounceHandler
Gerrit-Branch: master
Gerrit-Owner: 01tonythomas <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
