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  * @author Aaron Schulz
  20  */
  21 use Psr\Log\LoggerInterface;
  22 use Psr\Log\LoggerAwareInterface;
  23 use Psr\Log\NullLogger;
  24
  25 /**
  26  * Base class for reliable event relays
  27  */
  28 abstract class EventRelayer implements LoggerAwareInterface {
  29         /** @var LoggerInterface */
  30         protected $logger;
  31
  32         /**
  33          * @param array $params
  34          */
  35         public function __construct( array $params ) {
  36                 $this->logger = new NullLogger();
  37         }
  38
  39         /**
  40          * @param string $channel
  41          * @param array $event Event data map
  42          * @return bool Success
  43          */
  44         final public function notify( $channel, $event ) {
  45                 return $this->doNotify( $channel, [ $event ] );
  46         }
  47
  48         /**
  49          * @param string $channel
  50          * @param array $events List of event data maps
  51          * @return bool Success
  52          */
  53         final public function notifyMulti( $channel, $events ) {
  54                 return $this->doNotify( $channel, $events );
  55         }
  56
  57         /**
  58          * Set logger instance.
  59          * @param LoggerInterface $logger
  60          */
  61         public function setLogger( LoggerInterface $logger ) {
  62                 $this->logger = $logger;
  63         }
  64
  65         /**
  66          * @param string $channel
  67          * @param array $events List of event data maps
  68          * @return bool Success
  69          */
  70         abstract protected function doNotify( $channel, array $events );
  71 }
  72