includes/libs/eventrelayer/EventRelayer.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20 use Psr\Log\LoggerInterface;
  21 use Psr\Log\LoggerAwareInterface;
  22 use Psr\Log\NullLogger;
  23
  24 /**
  25  * Base class for reliable event relays
  26  */
  27 abstract class EventRelayer implements LoggerAwareInterface {
  28         /** @var LoggerInterface */
  29         protected $logger;
  30
  31         /**
  32          * @param array $params
  33          */
  34         public function __construct( array $params ) {
  35                 $this->logger = new NullLogger();
  36         }
  37
  38         /**
  39          * @param string $channel
  40          * @param array $event Event data map
  41          * @return bool Success
  42          */
  43         final public function notify( $channel, $event ) {
  44                 return $this->doNotify( $channel, [ $event ] );
  45         }
  46
  47         /**
  48          * @param string $channel
  49          * @param array $events List of event data maps
  50          * @return bool Success
  51          */
  52         final public function notifyMulti( $channel, $events ) {
  53                 return $this->doNotify( $channel, $events );
  54         }
  55
  56         public function setLogger( LoggerInterface $logger ) {
  57                 $this->logger = $logger;
  58         }
  59
  60         /**
  61          * @param string $channel
  62          * @param array $events List of event data maps
  63          * @return bool Success
  64          */
  65         abstract protected function doNotify( $channel, array $events );
  66 }