Page MenuHomeWickedGov Phorge
Files F1431235

EchoHooks.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

EchoHooks.php
View Options

<?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;
}
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 20:13 (1 d, 4 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
a5/78/7604bf9b3d305cd647ef587ec93e
Default Alt Text
EchoHooks.php (3 KB)

Event Timeline