mediawiki-extensions-Echo/includes/formatters/UserRightsPresentationModel.php
This, that and the other 3f99672d5e Add proper message when user group expiry is changed
There's a lot more that could be done to improve user "rights"
notifications (really user group notifications), but this will do for now.

Bug: T159301
Depends-On: I5d32445f8e5b41599889b8488a2431e7a908f858
Change-Id: I27d52bc5c39219c832bf63a491faa1e421b0c024
2017-04-10 11:38:49 -07:00

111 lines
3.7 KiB
PHP

<?php
/**
* Formatter for 'user-rights' notifications
*/
class EchoUserRightsPresentationModel extends EchoEventPresentationModel {
public function getIconType() {
return 'user-rights';
}
public function getHeaderMessage() {
list( $formattedName, $genderName ) = $this->getAgentForOutput();
$add = array_map(
[ $this->language, 'embedBidi' ],
$this->getLocalizedGroupNames( array_values( $this->event->getExtraParam( 'add', [] ) ) )
);
$remove = array_map(
[ $this->language, 'embedBidi' ],
$this->getLocalizedGroupNames( array_values( $this->event->getExtraParam( 'remove', [] ) ) )
);
$expiryChanged = array_map(
[ $this->language, 'embedBidi' ],
$this->getLocalizedGroupNames( array_values( $this->event->getExtraParam( 'expiry-changed', [] ) ) )
);
if ( $expiryChanged ) {
$msg = $this->msg( 'notification-header-user-rights-expiry-change' );
$msg->params( $genderName );
$msg->params( $this->language->commaList( $expiryChanged ) );
$msg->params( count( $expiryChanged ) );
$msg->params( $this->getViewingUserForGender() );
return $msg;
} elseif ( $add && !$remove ) {
$msg = $this->msg( 'notification-header-user-rights-add-only' );
$msg->params( $genderName );
$msg->params( $this->language->commaList( $add ) );
$msg->params( count( $add ) );
$msg->params( $this->getViewingUserForGender() );
return $msg;
} elseif ( !$add && $remove ) {
$msg = $this->msg( 'notification-header-user-rights-remove-only' );
$msg->params( $genderName );
$msg->params( $this->language->commaList( $remove ) );
$msg->params( count( $remove ) );
$msg->params( $this->getViewingUserForGender() );
return $msg;
} else {
$msg = $this->msg( 'notification-header-user-rights-add-and-remove' );
$msg->params( $genderName );
$msg->params( $this->language->commaList( $add ) );
$msg->params( count( $add ) );
$msg->params( $this->language->commaList( $remove ) );
$msg->params( count( $remove ) );
$msg->params( $this->getViewingUserForGender() );
return $msg;
}
}
public function getBodyMessage() {
$reason = $this->event->getExtraParam( 'reason' );
return $reason ? $this->msg( 'notification-body-user-rights' )->params( $reason ) : false;
}
private function getLocalizedGroupNames( $names ) {
return array_map( function( $name ) {
$msg = $this->msg( 'group-' . $name );
return $msg->isBlank() ? $name : $msg->text();
}, $names );
}
public function getPrimaryLink() {
$addedGroups = array_values( $this->event->getExtraParam( 'add', [] ) );
$removedGroups = array_values( $this->event->getExtraParam( 'remove', [] ) );
if ( count( $addedGroups ) >= 1 && count( $removedGroups ) === 0 ) {
$fragment = $addedGroups[0];
} elseif ( count( $addedGroups ) === 0 && count( $removedGroups ) >= 1 ) {
$fragment = $removedGroups[0];
} else {
$fragment = '';
}
return [
'url' => SpecialPage::getTitleFor( 'Listgrouprights', false, $fragment )->getFullURL(),
'label' => $this->msg( 'echo-learn-more' )->text()
];
}
public function getSecondaryLinks() {
return [ $this->getAgentLink(), $this->getLogLink() ];
}
private function getLogLink() {
$affectedUserPage = User::newFromId( $this->event->getExtraParam( 'user' ) )->getUserPage();
$query = [
'type' => 'rights',
'page' => $affectedUserPage->getPrefixedText(),
'user' => $this->event->getAgent()->getName(),
];
return [
'label' => $this->msg( 'echo-log' )->text(),
'url' => SpecialPage::getTitleFor( 'Log' )->getFullURL( $query ),
'description' => '',
'icon' => false,
'prioritized' => true,
];
}
protected function getSubjectMessageKey() {
return 'notification-user-rights-email-subject';
}
}