Page MenuHomeWickedGov Phorge
Files F5987497

EchoMentionStatusPresentationModel.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

EchoMentionStatusPresentationModel.php
View Options

<?php
namespace MediaWiki\Extension\Notifications\Formatters;
use MediaWiki\Extension\Notifications\Model\Event;
use MediaWiki\Language\Language;
use MediaWiki\User\User;
/**
* Presenter for 'mention-failure' and 'mention-success' notifications
*
* @author Christoph Fischer <christoph.fischer@wikimedia.de>
*
* @license MIT
*/
class EchoMentionStatusPresentationModel extends EchoEventPresentationModel {
protected EchoPresentationModelSection $section;
/**
* @inheritDoc
*/
protected function __construct( Event $event, Language $language, User $user, $distributionType ) {
parent::__construct( $event, $language, $user, $distributionType );
$this->section = new EchoPresentationModelSection( $event, $user, $language );
}
/** @inheritDoc */
public function getIconType() {
if ( $this->isMixedBundle() ) {
return 'mention-status-bundle';
}
if ( $this->isMentionSuccess() ) {
return 'mention-success';
}
return 'mention-failure';
}
/** @inheritDoc */
public function canRender() {
return (bool)$this->event->getTitle();
}
/** @inheritDoc */
public function getHeaderMessage() {
if ( $this->isTooManyMentionsFailure() ) {
$msg = $this->getMessageWithAgent( 'notification-header-mention-failure-too-many' );
$msg->numParams( $this->getMaxMentions() );
return $msg;
}
if ( $this->isBundled() ) {
if ( $this->isMixedBundle() ) {
$successCount = $this->getBundleSuccessCount();
$msg = $this->getMessageWithAgent( 'notification-header-mention-status-bundle' );
$msg->numParams( $this->getBundleCount() );
$msg->params( $this->getTruncatedTitleText( $this->event->getTitle() ) );
$msg->numParams( $this->getBundleCount() - $successCount );
$msg->numParams( $successCount );
return $msg;
}
if ( $this->isMentionSuccess() ) {
$msgKey = 'notification-header-mention-success-bundle';
} else {
$msgKey = 'notification-header-mention-failure-bundle';
}
$msg = $this->getMessageWithAgent( $msgKey );
$msg->numParams( $this->getBundleCount() );
$msg->params( $this->getTruncatedTitleText( $this->event->getTitle() ) );
return $msg;
}
if ( $this->isMentionSuccess() ) {
$msgKey = 'notification-header-mention-success';
} else {
// Messages that can be used here:
// * notification-header-mention-failure-user-unknown
// * notification-header-mention-failure-user-anonymous
$msgKey = 'notification-header-mention-failure-' . $this->getFailureType();
}
$msg = $this->getMessageWithAgent( $msgKey );
$msg->params( $this->getSubjectName() );
return $msg;
}
/** @inheritDoc */
public function getCompactHeaderMessage() {
if ( $this->isMentionSuccess() ) {
$msg = $this->getMessageWithAgent( 'notification-compact-header-mention-success' );
} else {
// Messages that can be used here:
// * notification-compact-header-mention-failure-user-unknown
// * notification-compact-header-mention-failure-user-anonymous
$msg = $this->msg( 'notification-compact-header-mention-failure-' . $this->getFailureType() );
}
$msg->params( $this->getSubjectName() );
return $msg;
}
/** @inheritDoc */
public function getPrimaryLink() {
return [
// Need FullURL so the section is included
'url' => $this->section->getTitleWithSection()->getFullURL(),
'label' => $this->msg( 'notification-link-text-view-mention-failure' )
->numParams( $this->getBundleCount() )
->text(),
];
}
/** @inheritDoc */
public function getSecondaryLinks() {
if ( $this->isBundled() ) {
return [];
}
$talkPageLink = $this->getPageLink(
$this->section->getTitleWithSection(),
'',
true
);
return [ $talkPageLink ];
}
public function isMentionSuccessEvent( Event $event ): bool {
return $event->getType() === 'mention-success';
}
private function isMentionSuccess(): bool {
return $this->isMentionSuccessEvent( $this->event );
}
private function getSubjectName(): string {
return $this->event->getExtraParam( 'subject-name', '' );
}
private function getFailureType(): string {
return $this->event->getExtraParam( 'failure-type', 'user-unknown' );
}
private function isTooManyMentionsFailure(): bool {
return $this->getFailureType() === 'too-many' ||
$this->getType() === 'mention-failure-too-many';
}
private function getMaxMentions(): int {
global $wgEchoMaxMentionsCount;
return $this->event->getExtraParam( 'max-mentions', $wgEchoMaxMentionsCount );
}
private function getBundleSuccessCount(): int {
$events = array_merge( $this->getBundledEvents(), [ $this->event ] );
return count( array_filter( $events, [ $this, 'isMentionSuccessEvent' ] ) );
}
private function isMixedBundle(): bool {
$successCount = $this->getBundleSuccessCount();
$failCount = $this->getBundleCount() - $successCount;
return $successCount > 0 && $failCount > 0;
}
}
class_alias( EchoMentionStatusPresentationModel::class, 'EchoMentionStatusPresentationModel' );

File Metadata

Mime Type
text/x-php
Expires
Sun, Oct 4, 00:27 (2 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
c0/e5/0d6501bc2f80635e1701e38a1d1b
Default Alt Text
EchoMentionStatusPresentationModel.php (4 KB)

Event Timeline