Page MenuHomeWickedGov Phorge
Files F4118340

EchoEventFormatter.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

EchoEventFormatter.php
View Options

<?php
namespace MediaWiki\Extension\Notifications\Formatters;
use MediaWiki\Extension\Notifications\Model\Event;
use MediaWiki\Language\Language;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\Message\Message;
use MediaWiki\User\User;
/**
* 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 );
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 02:44 (2 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
7c/18/aa66e680cfb18dc3a4cd41ad214f
Default Alt Text
EchoEventFormatter.php (2 KB)

Event Timeline