includes/rcfeed/RCFeed.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
  21 /**
  22  * @see $wgRCFeeds
  23  * @since 1.29
  24  */
  25 abstract class RCFeed {
  26         /**
  27          * @param array $params
  28          */
  29         public function __construct( array $params = [] ) {
  30         }
  31
  32         /**
  33          * Dispatch the recent changes notification.
  34          *
  35          * @param RecentChange $rc
  36          * @param string|null $actionComment
  37          * @return bool Success
  38          */
  39         abstract public function notify( RecentChange $rc, $actionComment = null );
  40
  41         /**
  42          * @param array $params
  43          * @return RCFeed
  44          * @throws Exception
  45          */
  46         final public static function factory( array $params ) {
  47                 if ( !isset( $params['class'] ) ) {
  48                         if ( !isset( $params['uri'] ) ) {
  49                                 throw new Exception( "RCFeeds must have a 'class' or 'uri' set." );
  50                         }
  51                         return RecentChange::getEngine( $params['uri'], $params );
  52                 }
  53                 $class = $params['class'];
  54                 if ( !class_exists( $class ) ) {
  55                         throw new Exception( "Unknown class '$class'." );
  56                 }
  57                 return new $class( $params );
  58         }
  59 }