wiki.techinc.nl/includes/logging/RCDatabaseLogEntry.php
Umherirrender 44fd53fee3 Using @return never documentation on always-throw-function
This helps phan to detect unreachable code and also impossible types
after the functions.
It helps phan to avoid false positives for array keys
when the keys are checked before

Bug: T240141
Change-Id: I895f70e82b3053a46cd44135b15437e6f82a07b2
2021-09-07 17:29:03 +02:00

112 lines
3.3 KiB
PHP

<?php
/**
* Contains a class for dealing with recent changes database log entries
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @author Niklas Laxström
* @license GPL-2.0-or-later
* @since 1.19
*/
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
use MediaWiki\User\UserIdentity;
use Wikimedia\Rdbms\IDatabase;
/**
* A subclass of DatabaseLogEntry for objects constructed from entries in the
* recentchanges table (rather than the logging table).
*
* This class should only be used in context of the LogFormatter class.
*/
class RCDatabaseLogEntry extends DatabaseLogEntry {
public static function newFromId( $id, IDatabase $db ) {
// @phan-suppress-previous-line PhanPluginNeverReturnMethod
// Make the LSP violation explicit to prevent sneaky failures
throw new LogicException( 'Not implemented!' );
}
public static function getSelectQueryData() {
// @phan-suppress-previous-line PhanPluginNeverReturnMethod
// Make the LSP violation explicit to prevent sneaky failures
throw new LogicException( 'Not implemented!' );
}
public function getId() {
return $this->row->rc_logid;
}
protected function getRawParameters() {
return $this->row->rc_params;
}
public function getAssociatedRevId() {
return $this->row->rc_this_oldid;
}
public function getType() {
return $this->row->rc_log_type;
}
public function getSubtype() {
return $this->row->rc_log_action;
}
public function getPerformerIdentity(): UserIdentity {
if ( !$this->performer ) {
$actorStore = MediaWikiServices::getInstance()->getActorStore();
try {
$this->performer = $actorStore->newActorFromRowFields(
$this->row->rc_user ?? 0,
$this->row->rc_user_text,
$this->row->rc_actor ?? null
);
} catch ( InvalidArgumentException $e ) {
LoggerFactory::getInstance( 'logentry' )->warning(
'Failed to instantiate RC log entry performer', [
'exception' => $e,
'log_id' => $this->getId()
]
);
$this->performer = $actorStore->getUnknownActor();
}
}
return $this->performer;
}
public function getTarget() {
$namespace = $this->row->rc_namespace;
$page = $this->row->rc_title;
return Title::makeTitle( $namespace, $page );
}
public function getTimestamp() {
return wfTimestamp( TS_MW, $this->row->rc_timestamp );
}
public function getComment() {
return CommentStore::getStore()
// Legacy because the row may have used RecentChange::selectFields()
->getCommentLegacy( wfGetDB( DB_REPLICA ), 'rc_comment', $this->row )->text;
}
public function getDeleted() {
return $this->row->rc_deleted;
}
}