mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo
synced 2024-12-24 13:44:40 +00:00
a0ca1d89c6
Changes to the use statements done automatically via script Addition of missing use statements done manually Change-Id: Iad87245bf8082193be72f7e482f29e9f1bad11fc
86 lines
2.1 KiB
PHP
86 lines
2.1 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Extension\Notifications\Formatters;
|
|
|
|
use Language;
|
|
use MediaWiki\Extension\Notifications\Model\Event;
|
|
use MediaWiki\Logger\LoggerFactory;
|
|
use MediaWiki\User\User;
|
|
use Message;
|
|
|
|
/**
|
|
* Abstract class that each "formatter" should implement.
|
|
*
|
|
* A formatter is an output type, example formatters would be:
|
|
* * Special:Notifications
|
|
* * HTML email
|
|
* * plaintext email
|
|
*
|
|
* The formatter does not maintain any state except for the
|
|
* arguments passed in the constructor (user and language)
|
|
*/
|
|
abstract class EchoEventFormatter {
|
|
|
|
/** @var User */
|
|
protected $user;
|
|
|
|
/** @var Language */
|
|
protected $language;
|
|
|
|
public function __construct( User $user, Language $language ) {
|
|
$this->user = $user;
|
|
$this->language = $language;
|
|
}
|
|
|
|
/**
|
|
* Equivalent to IContextSource::msg for the current
|
|
* language
|
|
*
|
|
* @param string $key
|
|
* @param mixed ...$params
|
|
* @return Message
|
|
*/
|
|
protected function msg( string $key, ...$params ) {
|
|
$msg = wfMessage( $key, ...$params );
|
|
$msg->inLanguage( $this->language );
|
|
|
|
return $msg;
|
|
}
|
|
|
|
/**
|
|
* @param Event $event
|
|
* @param string $distributionType 'web' or 'email'
|
|
* @return string[]|string|false Output format depends on implementation, false if it cannot be formatted
|
|
*/
|
|
final public function format( Event $event, string $distributionType = "web" ) {
|
|
// Deleted events should have been filtered out before getting there.
|
|
// This is just to be sure.
|
|
if ( $event->isDeleted() ) {
|
|
return false;
|
|
}
|
|
|
|
if ( !EchoEventPresentationModel::supportsPresentationModel( $event->getType() ) ) {
|
|
LoggerFactory::getInstance( 'Echo' )->debug(
|
|
"No presentation model found for event type \"{type}\"",
|
|
[
|
|
'type' => $event->getType(),
|
|
]
|
|
);
|
|
return false;
|
|
}
|
|
|
|
$model = EchoEventPresentationModel::factory( $event, $this->language, $this->user, $distributionType );
|
|
if ( !$model->canRender() ) {
|
|
return false;
|
|
}
|
|
|
|
return $this->formatModel( $model );
|
|
}
|
|
|
|
/**
|
|
* @param EchoEventPresentationModel $model
|
|
* @return string[]|string
|
|
*/
|
|
abstract protected function formatModel( EchoEventPresentationModel $model );
|
|
}
|