wiki.techinc.nl/includes/rcfeed/FormattedRCFeed.php
Daimona Eaytoy 41ee2f2c61 Upgrade phan to 0.9.1
Released just now.

Many old suppressions can now be removed. Enabling the issue for
undeclared variables is left to do later, given that there are
roughly 200 warning.

Change-Id: I99462a1e9232d6e75022912e2df82bc2038476ef
2020-01-25 10:53:26 +00:00

68 lines
2.1 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 RC feed engines that send messages in a freely configurable
* format to a uri-addressed engine set in $wgRCEngines.
* @since 1.29
*/
abstract class FormattedRCFeed extends RCFeed {
private $params;
/**
* @param array $params
* - 'uri'
* - 'formatter'
* @see $wgRCFeeds
*/
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 );
}
}