Manual:$wgRCFeeds

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Manual:$wgRCFeeds and the translation is 21% complete.

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎日本語 • ‎polski • ‎português • ‎português do Brasil
UDP updates: $wgRCFeeds
Configuration for sending RC updates
導入されたバージョン: 1.22.0
除去されたバージョン: 使用中
可能な値: 未指定
既定値: array()
他の設定: アルファベット順 | 機能順

詳細

This variable is for configuring where MediaWiki will send network updates for recent changes. This is called after recent changes info have been inserted into the recentchanges table.

使用法

MediaWiki supports sending recent changes updates to any number of destinations. Therefore this variable is an array, with each entry being a descriptor of where and how to send the data.

Each descriptor is an associative array with the following keys:

formatter 
Fully qualified class name for the class that will format the data for sending over the network. It must inherit the RCFeedFormatter interface.
uri 
URI to send the data to (the protocol indicates what engine is used to send the data)
add_interwiki_prefix 
True or false whether to add the interwiki prefix to the data ($wgLocalInterwikisManual:$wgLocalInterwikis)
omit_bots 
True or false whether to skip bot edits

As mentioned, the formatter key specifies what class will be used to format the data, and the protocol of the URI specifies how to actually send the data. See $wgRCEnginesManual:$wgRCEngines for how to configure the mapping of protocols to engines.

Formatters

A formatter needs to be specified in order for the data to be translated properly before going over the network. MediaWiki has the following built-in formatter classes:

JSONRCFeedFormatter 
Outputs the RC information in a JSON dictionary
IRCColourfulRCFeedFormatter 
Outputs an IRC line with color codes for broadcast to an IRC server

エンジン

Engines are the method by which the recentchange notifications are sent. MediaWiki has the following built-in engines:

UDPRCFeedEngine
Sends via a UDP packet
RedisPubSubFeedEngine
Sends via Redis Pub/Sub

Here are some example configurations:

$wgRCFeeds['example'] = array(
    'formatter' => 'JSONRCFeedFormatter',
    'uri' => 'redis://127.0.0.1:6379/rc.$wgDBname',
    'add_interwiki_prefix' => false,
    'omit_bots' => true,
);

$wgRCFeeds['exampleirc'] = array(
    'formatter' => 'IRCColourfulRCFeedFormatter',
    'uri' => 'udp://localhost:1338',
    'add_interwiki_prefix' => false,
    'omit_bots' => true,
);

関連項目