f8ecea1e5c
Follows-up 39a6e3dc4d (I8be497c623c5d92).
* Improve documentation all around and advertise 'class'
everywhere instead of 'uri'.
* Add test coverage for RCFeed::factory().
* Deprecate the $wgRCEngines "uri to class" mapping in favour
of specifying "class" directly in $wgRCFeeds.
* Deprecate RCFeedEngine in favour of FormattedRCFeed.
Convert to class_alias so that UDPRCFeedEngine no longer has
to extend the deprecated class name explicitly (for instanceof compat).
* Hard-deprecate RecentChange::getEngine.
Bug: T250628
Depends-On: Ie939e1d06b9ee2d841ec7256c8d24cc4e7e386dd
Change-Id: Ib6758d724c7200404c89c7ab157aa55f1cad9763
77 lines
2.3 KiB
PHP
77 lines
2.3 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
/**
|
|
* @see $wgRCFeeds
|
|
* @since 1.29
|
|
*/
|
|
abstract class RCFeed {
|
|
/**
|
|
* @param array $params
|
|
*/
|
|
public function __construct( array $params = [] ) {
|
|
}
|
|
|
|
/**
|
|
* Dispatch the recent changes notification.
|
|
*
|
|
* @param RecentChange $rc
|
|
* @param string|null $actionComment
|
|
* @return bool Success
|
|
*/
|
|
abstract public function notify( RecentChange $rc, $actionComment = null );
|
|
|
|
/**
|
|
* @param array $params
|
|
* @return RCFeed
|
|
*/
|
|
final public static function factory( array $params ): RCFeed {
|
|
if ( !isset( $params['class'] ) ) {
|
|
if ( !isset( $params['uri'] ) ) {
|
|
throw new InvalidArgumentException( 'RCFeeds must have a class set' );
|
|
}
|
|
if ( strpos( $params['uri'], 'udp:' ) === 0 ) {
|
|
$params['class'] = UDPRCFeedEngine::class;
|
|
} elseif ( strpos( $params['uri'], 'redis:' ) === 0 ) {
|
|
$params['class'] = RedisPubSubFeedEngine::class;
|
|
} else {
|
|
global $wgRCEngines;
|
|
wfDeprecated( '$wgRCFeeds without class', '1.38' );
|
|
$scheme = parse_url( $params['uri'], PHP_URL_SCHEME );
|
|
if ( !$scheme ) {
|
|
throw new InvalidArgumentException( "Invalid RCFeed uri: {$params['uri']}" );
|
|
}
|
|
if ( !isset( $wgRCEngines[$scheme] ) ) {
|
|
throw new InvalidArgumentException( "Unknown RCFeed engine: $scheme" );
|
|
}
|
|
$params['class'] = $wgRCEngines[$scheme];
|
|
}
|
|
}
|
|
|
|
$class = $params['class'];
|
|
if ( defined( 'MW_PHPUNIT_TEST' ) && is_object( $class ) ) {
|
|
return $class;
|
|
}
|
|
if ( !class_exists( $class ) ) {
|
|
throw new InvalidArgumentException( "Unknown class '$class'." );
|
|
}
|
|
return new $class( $params );
|
|
}
|
|
}
|