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
  22 /**
  23  * Base class for reliable event relays
  24  */
  25 abstract class EventRelayer {
  26         /**
  27          * @param array $params
  28          */
  29         public function __construct( array $params ) {
  30         }
  31
  32         /**
  33          * @param string $channel
  34          * @param array $event Event data map
  35          * @return bool Success
  36          */
  37         final public function notify( $channel, $event ) {
  38                 return $this->doNotify( $channel, array( $event ) );
  39         }
  40
  41         /**
  42          * @param string $channel
  43          * @param array $events List of event data maps
  44          * @return bool Success
  45          */
  46         final public function notifyMulti( $channel, $events ) {
  47                 return $this->doNotify( $channel, $events );
  48         }
  49
  50         /**
  51          * @param string $channel
  52          * @param array $events List of event data maps
  53          * @return bool Success
  54          */
  55         abstract protected function doNotify( $channel, array $events );
  56 }
  57
  58 /**
  59  * No-op class for publishing messages into a PubSub system
  60  */
  61 class EventRelayerNull extends EventRelayer {
  62         public function doNotify( $channel, array $events ) {
  63                 return true;
  64         }
  65 }