MediaWiki\Notification\NotificationsBatch Class Reference
An object representing notification with list of recipients. More...
Inherits Countable, and IteratorAggregate.
Collaboration diagram for MediaWiki\Notification\NotificationsBatch:
Public Member Functions | |
| __construct (NotificationEnvelope ... $envelopes) | |
| add (NotificationEnvelope $envelope) | |
| count () | |
| filter ( $callback) | |
| getIterator () | |
| remove (NotificationEnvelope $envelope) | |
Detailed Description
An object representing notification with list of recipients.
- Stability: newable
- Since
- 1.45
Definition at line 13 of file NotificationsBatch.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Notification\NotificationsBatch::__construct | ( | NotificationEnvelope ... | $envelopes | ) |
Definition at line 18 of file NotificationsBatch.php.
References MediaWiki\Notification\NotificationsBatch\add().
Member Function Documentation
◆ add()
| MediaWiki\Notification\NotificationsBatch::add | ( | NotificationEnvelope | $envelope | ) |
Definition at line 24 of file NotificationsBatch.php.
Referenced by MediaWiki\Notification\NotificationsBatch\__construct().
◆ count()
| MediaWiki\Notification\NotificationsBatch::count | ( | ) |
Definition at line 39 of file NotificationsBatch.php.
◆ filter()
| MediaWiki\Notification\NotificationsBatch::filter | ( | $callback | ) |
- Parameters
-
callable(NotificationEnvelope) bool $callback Filter, return true to preserve the $envelope
Definition at line 35 of file NotificationsBatch.php.
◆ getIterator()
| MediaWiki\Notification\NotificationsBatch::getIterator | ( | ) |
- Returns
- ArrayIterator<NotificationEnvelope>
Definition at line 46 of file NotificationsBatch.php.
◆ remove()
| MediaWiki\Notification\NotificationsBatch::remove | ( | NotificationEnvelope | $envelope | ) |
Definition at line 28 of file NotificationsBatch.php.
The documentation for this class was generated from the following file:
- includes/Notification/NotificationsBatch.php
