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
76 lines
2.2 KiB
PHP
76 lines
2.2 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
|
|
*/
|
|
|
|
/**
|
|
* Base class for RCFeed implementations that use RCFeedFormatter.
|
|
*
|
|
* Parameters:
|
|
* - formatter: [required] Which RCFeedFormatter class to use.
|
|
*
|
|
* @see $wgRCFeeds
|
|
* @since 1.29
|
|
*/
|
|
abstract class FormattedRCFeed extends RCFeed {
|
|
private $params;
|
|
|
|
/**
|
|
* @param array $params
|
|
*/
|
|
public function __construct( array $params ) {
|
|
$this->params = $params;
|
|
}
|
|
|
|
/**
|
|
* Send some text to the specified feed.
|
|
*
|
|
* @param array $feed The feed, as configured in an associative array
|
|
* @param string $line The text to send
|
|
* @return bool Success
|
|
*/
|
|
abstract public function send( array $feed, $line );
|
|
|
|
/**
|
|
* @param RecentChange $rc
|
|
* @param string|null $actionComment
|
|
* @return bool Success
|
|
*/
|
|
public function notify( RecentChange $rc, $actionComment = null ) {
|
|
$params = $this->params;
|
|
/** @var RCFeedFormatter $formatter */
|
|
$formatter = is_object( $params['formatter'] ) ? $params['formatter'] : new $params['formatter'];
|
|
|
|
$line = $formatter->getLine( $params, $rc, $actionComment );
|
|
if ( !$line ) {
|
|
// @codeCoverageIgnoreStart
|
|
// T109544 - If a feed formatter returns null, this will otherwise cause an
|
|
// error in at least RedisPubSubFeedEngine. Not sure best to handle this.
|
|
return;
|
|
// @codeCoverageIgnoreEnd
|
|
}
|
|
return $this->send( $params, $line );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Backward-compatibility alias.
|
|
* @since 1.22
|
|
* @deprecated since 1.29 Use FormattedRCFeed instead
|
|
*/
|
|
class_alias( FormattedRCFeed::class, 'RCFeedEngine' );
|