mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Thanks
synced 2024-12-24 04:02:49 +00:00
c697355f04
Changes to the use statements done automatically via script Addition of missing use statement done manually Change-Id: I230ada2f4ad95f86593759e8320d47acdf06a749
114 lines
3.1 KiB
PHP
114 lines
3.1 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Extension\Thanks;
|
|
|
|
use MediaWiki\Extension\Notifications\AttributeManager;
|
|
use MediaWiki\Extension\Notifications\Hooks\BeforeCreateEchoEventHook;
|
|
use MediaWiki\Extension\Notifications\Hooks\EchoGetBundleRulesHook;
|
|
use MediaWiki\Extension\Notifications\Model\Event;
|
|
use MediaWiki\Extension\Notifications\UserLocator;
|
|
use MediaWiki\Registration\ExtensionRegistry;
|
|
|
|
/**
|
|
* Hooks for Thanks extension
|
|
*
|
|
* @file
|
|
* @ingroup Extensions
|
|
*/
|
|
class EchoHooks implements BeforeCreateEchoEventHook, EchoGetBundleRulesHook {
|
|
|
|
/**
|
|
* Add Thanks events to Echo
|
|
*
|
|
* @param array &$notifications array of Echo notifications
|
|
* @param array &$notificationCategories array of Echo notification categories
|
|
* @param array &$icons array of icon details
|
|
*/
|
|
public function onBeforeCreateEchoEvent(
|
|
array &$notifications, array &$notificationCategories, array &$icons
|
|
) {
|
|
$notificationCategories['edit-thank'] = [
|
|
'priority' => 3,
|
|
'tooltip' => 'echo-pref-tooltip-edit-thank',
|
|
];
|
|
|
|
$notifications['edit-thank'] = [
|
|
// The following message is generated by the category name:
|
|
// * echo-category-title-edit-thank
|
|
'category' => 'edit-thank',
|
|
'group' => 'positive',
|
|
'section' => 'message',
|
|
'presentation-model' => EchoCoreThanksPresentationModel::class,
|
|
'bundle' => [
|
|
'web' => true,
|
|
'expandable' => true,
|
|
],
|
|
AttributeManager::ATTR_LOCATORS => [
|
|
[
|
|
[ UserLocator::class, 'locateFromEventExtra' ],
|
|
[ 'thanked-user-id' ]
|
|
],
|
|
],
|
|
];
|
|
|
|
if ( ExtensionRegistry::getInstance()->isLoaded( 'Flow' ) ) {
|
|
$notifications['flow-thank'] = [
|
|
'category' => 'edit-thank',
|
|
'group' => 'positive',
|
|
'section' => 'message',
|
|
'presentation-model' => EchoFlowThanksPresentationModel::class,
|
|
'bundle' => [
|
|
'web' => true,
|
|
'expandable' => true,
|
|
],
|
|
AttributeManager::ATTR_LOCATORS => [
|
|
[
|
|
[ UserLocator::class, 'locateFromEventExtra' ],
|
|
[ 'thanked-user-id' ]
|
|
],
|
|
],
|
|
];
|
|
}
|
|
|
|
$icons['thanks'] = [
|
|
'path' => [
|
|
'ltr' => 'Thanks/modules/userTalk-constructive-ltr.svg',
|
|
'rtl' => 'Thanks/modules/userTalk-constructive-rtl.svg'
|
|
]
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Handler for EchoGetBundleRule hook, which defines the bundle rules for each notification.
|
|
*
|
|
* @param Event $event The event being notified.
|
|
* @param string &$bundleString Determines how the notification should be bundled.
|
|
*/
|
|
public function onEchoGetBundleRules( Event $event, string &$bundleString ) {
|
|
switch ( $event->getType() ) {
|
|
case 'edit-thank':
|
|
$bundleString = 'edit-thank';
|
|
// Try to get either the revid or logid parameter.
|
|
$revOrLogId = $event->getExtraParam( 'logid' );
|
|
if ( $revOrLogId ) {
|
|
// avoid collision with revision ids
|
|
$revOrLogId = 'log' . $revOrLogId;
|
|
} else {
|
|
$revOrLogId = $event->getExtraParam( 'revid' );
|
|
}
|
|
if ( $revOrLogId ) {
|
|
$bundleString .= $revOrLogId;
|
|
}
|
|
break;
|
|
case 'flow-thank':
|
|
$bundleString = 'flow-thank';
|
|
$postId = $event->getExtraParam( 'post-id' );
|
|
if ( $postId ) {
|
|
$bundleString .= $postId;
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
}
|