Class to simplify the use of log pages. More...

Collaboration diagram for LogPage:

[legend]

Public Member Functions
	__construct ( $type, $rc=true, $udp='skipUDP')
	Stable to call.

	addEntry ( $action, $target, $comment, $params=[], $doer=null)
	Add a log entry.

	addRelations ( $field, $values, $logid)
	Add relations to log_search table.

	getComment ()
	Get the comment from the last addEntry() call.

	getDescription ()
	Description of this log type.

	getName ()
	Name of the log.

	getRcComment ()
	Get the RC comment from the last addEntry() call.

	getRcCommentIRC ()
	Get the RC comment from the last addEntry() call for IRC.

	getRestriction ()
	Returns the right needed to read this log type.

	isRestricted ()
	Tells if this log is not viewable by all.

Static Public Member Functions
static	actionText ( $type, $action, $title=null, $skin=null, $params=[], $filterWikilinks=false)
	Generate text for a log entry.

static	extractParams ( $blob)
	Extract a parameter array from a blob.

static	isLogType ( $type)
	Is $type a valid log type.

static	makeParamBlob ( $params)
	Create a blob from a parameter array.

static	validTypes ()
	Get the list of valid log types.

Public Attributes
bool	$sendToUDP

bool	$updateRecentChanges

const	DELETED_ACTION = 1

const	DELETED_COMMENT = 2

const	DELETED_RESTRICTED = 8

const	DELETED_USER = 4

const	SUPPRESSED_ACTION = self::DELETED_ACTION \| self::DELETED_RESTRICTED

const	SUPPRESSED_USER = self::DELETED_USER \| self::DELETED_RESTRICTED

Protected Member Functions
	saveContent ()

Static Private Member Functions
static	getTitleLink (Title $title, ?Language $lang)

Private Attributes
string	$action
	One of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move', 'move_redir'.

string	$actionText
	Plaintext version of the message.

string	$comment
	Comment associated with action.

User	$doer
	The user doing the action.

string	$ircActionText
	Plaintext version of the message for IRC.

string	$params
	Blob made of a parameters array.

Title	$target

string	$type
	One of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move'.

Detailed Description

Class to simplify the use of log pages.

The logs are now kept in a table which is easier to manage and trim than ever-growing wiki pages.

@newable

Note: marked as newable in 1.35 for lack of a better alternative, but should become a stateless service, use use the command pattern.

Definition at line 37 of file LogPage.php.

Constructor & Destructor Documentation

◆ __construct()

LogPage::__construct	(	$type,
		$rc = `true`,
		$udp = `'skipUDP'`
	)

Stable to call.

Parameters

string	$type	One of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move'
bool	$rc	Whether to update recent changes as well as the logging table
string	$udp	Pass 'UDP' to send to the UDP feed if NOT sent to RC

Definition at line 88 of file LogPage.php.

References $type.

Member Function Documentation

◆ actionText()

static LogPage::actionText	(	$type,
		$action,
		$title = `null`,
		$skin = `null`,
		$params = `[]`,
		$filterWikilinks = `false`
	)

static

Generate text for a log entry.

Only LogFormatter should call this function.

Parameters

string	$type	Log type
string	$action	Log action
Title \| null	$title	Title object or null
Skin \| null	$skin	Skin object or null. If null, we want to use the wiki content language, since that will go to the IRC feed.
array	$params	Parameters
bool	$filterWikilinks	Whether to filter wiki links

Returns: string HTML

Definition at line 232 of file LogPage.php.

References $args, $params, $title, $wgLang, $wgLogActions, $wgLogActionsHandlers, getTitleLink(), StubObject\unstub(), wfDebug(), and wfMessage().

Referenced by LegacyLogFormatter\getActionMessage().

◆ addEntry()

LogPage::addEntry	(	$action,
		$target,
		$comment,
		$params = `[]`,
		$doer = `null`
	)

Add a log entry.

Parameters

string	$action	One of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move', 'move_redir'
Title	$target
string	$comment	Description associated
array	$params	Parameters passed later to wfMessage function
null \| int \| User	$doer	The user doing the action. null defaults $wgUser, and is deprecated since 1.35

Returns: int The log_id of the inserted log entry

Definition at line 335 of file LogPage.php.

References LogFormatter\newFromEntry(), User\newFromId(), and wfDeprecated().

◆ addRelations()

LogPage::addRelations	(	$field,
		$values,
		$logid
	)

Add relations to log_search table.

Parameters

string	$field
array	$values
int	$logid

Returns: bool

Definition at line 389 of file LogPage.php.

References DB_MASTER, and wfGetDB().

◆ extractParams()

static LogPage::extractParams ( $blob )

static

Extract a parameter array from a blob.

Parameters

string $blob

Returns: array

Definition at line 426 of file LogPage.php.

References $blob.

Referenced by PopulateLogSearch\doDBUpdates(), and DatabaseLogEntry\getParameters().

◆ getComment()

LogPage::getComment ( )

Get the comment from the last addEntry() call.

Returns: string

Definition at line 194 of file LogPage.php.

References $comment.

◆ getDescription()

LogPage::getDescription ( )

Description of this log type.

Returns: Message

Since: 1.19

Definition at line 453 of file LogPage.php.

References $type, $wgLogHeaders, and wfMessage().

◆ getName()

LogPage::getName ( )

Name of the log.

Returns: Message

Since: 1.19

Definition at line 439 of file LogPage.php.

References $type, $wgLogNames, and wfMessage().

◆ getRcComment()

LogPage::getRcComment ( )

Get the RC comment from the last addEntry() call.

Returns: string

Definition at line 155 of file LogPage.php.

References $actionText, $comment, and wfMessage().

Referenced by saveContent().

◆ getRcCommentIRC()

LogPage::getRcCommentIRC ( )

Get the RC comment from the last addEntry() call for IRC.

Returns: string

Definition at line 175 of file LogPage.php.

References $comment, $ircActionText, and wfMessage().

Referenced by saveContent().

◆ getRestriction()

LogPage::getRestriction ( )

Returns the right needed to read this log type.

Returns: string

Since: 1.19

Definition at line 466 of file LogPage.php.

References $type, and $wgLogRestrictions.

◆ getTitleLink()

static LogPage::getTitleLink	(	Title	$title,
		?Language	$lang
	)

staticprivate

Parameters

Title	$title
	?Language	$lang

Returns: string HTML

Definition at line 299 of file LogPage.php.

References $title.

Referenced by actionText().

◆ isLogType()

static LogPage::isLogType ( $type )

static

Is $type a valid log type.

Parameters

string $type Log type to check

Returns: bool

Definition at line 215 of file LogPage.php.

References $type.

Referenced by SpecialLog\execute().

◆ isRestricted()

LogPage::isRestricted ( )

Tells if this log is not viewable by all.

Returns: bool

Since: 1.19

Definition at line 477 of file LogPage.php.

◆ makeParamBlob()

static LogPage::makeParamBlob ( $params )

static

Create a blob from a parameter array.

Parameters

array $params

Returns: string

Definition at line 416 of file LogPage.php.

◆ saveContent()

LogPage::saveContent ( )

protected

Returns: int The log_id of the inserted log entry

Definition at line 97 of file LogPage.php.

References $action, $params, $type, $wgLogRestrictions, DB_MASTER, getRcComment(), getRcCommentIRC(), SpecialPage\getTitleFor(), wfGetDB(), and wfTimestampNow().

◆ validTypes()

static LogPage::validTypes ( )

static

Get the list of valid log types.

Returns: array Array of strings

Definition at line 203 of file LogPage.php.

References $wgLogTypes.

Referenced by ApiQueryLogEvents\getAllowedParams(), SpecialLog\getSubpagesForPrefixSearch(), LogEventsList\getTypeMenuDesc(), SpecialLog\parseParams(), and RebuildRecentchanges\rebuildRecentChangesTablePass3().

Member Data Documentation

◆ $action

string LogPage::$action

private

One of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move', 'move_redir'.

Definition at line 67 of file LogPage.php.

Referenced by saveContent().

◆ $actionText

string LogPage::$actionText

private

Plaintext version of the message.

Definition at line 57 of file LogPage.php.

Referenced by getRcComment().

◆ $comment

string LogPage::$comment

private

Comment associated with action.

Definition at line 70 of file LogPage.php.

Referenced by getComment(), getRcComment(), and getRcCommentIRC().

◆ $doer

User LogPage::$doer

private

The user doing the action.

Definition at line 76 of file LogPage.php.

◆ $ircActionText

string LogPage::$ircActionText

private

Plaintext version of the message for IRC.

Definition at line 54 of file LogPage.php.

Referenced by getRcCommentIRC().

◆ $params

string LogPage::$params

private

Blob made of a parameters array.

Definition at line 73 of file LogPage.php.

Referenced by actionText(), and saveContent().

◆ $sendToUDP

bool LogPage::$sendToUDP

Definition at line 51 of file LogPage.php.

◆ $target

Title LogPage::$target

private

Definition at line 79 of file LogPage.php.

◆ $type

string LogPage::$type

private

One of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move'.

Definition at line 62 of file LogPage.php.

Referenced by __construct(), isLogType(), and saveContent().

◆ $updateRecentChanges

bool LogPage::$updateRecentChanges

Definition at line 48 of file LogPage.php.

◆ DELETED_ACTION

const LogPage::DELETED_ACTION = 1

Definition at line 38 of file LogPage.php.

Referenced by SpecialWatchlist\doMainQuery(), LogPager\enforceActionRestrictions(), ApiQueryLogEvents\execute(), ApiQueryWatchlist\extractOutputData(), ApiQueryLogEvents\extractRowInfo(), ApiQueryRecentChanges\extractRowInfo(), BlockLogFormatter\getActionLinks(), ContentModelLogFormatter\getActionLinks(), DeleteLogFormatter\getActionLinks(), LegacyLogFormatter\getActionLinks(), MergeLogFormatter\getActionLinks(), MoveLogFormatter\getActionLinks(), ProtectLogFormatter\getActionLinks(), LogFormatter\getActionText(), RevDelLogItem\getApiData(), WatchedItemQueryService\getExtraDeletedPageLogEntryRelatedCond(), RevDelLogList\getRevdelConstant(), EnhancedChangesList\recentChangesBlockGroup(), ApiQueryRecentChanges\run(), RevisionDeleteUser\setUsernameBitfields(), and XmlDumpWriter\writeLogItem().

◆ DELETED_COMMENT

const LogPage::DELETED_COMMENT = 2

Definition at line 39 of file LogPage.php.

Referenced by ApiQueryLogEvents\extractRowInfo(), ProtectedPagesPager\formatValue(), RevDelLogItem\getApiData(), LogFormatter\getComment(), ChangeTagsLogItem\getHTML(), RevDelLogItem\getHTML(), EditPage\getLastDelete(), and XmlDumpWriter\writeLogItem().

◆ DELETED_RESTRICTED

const LogPage::DELETED_RESTRICTED = 8

Definition at line 41 of file LogPage.php.

Referenced by SpecialWatchlist\doMainQuery(), ApiQueryLogEvents\execute(), ApiQueryLogEvents\extractRowInfo(), WatchedItemQueryService\getExtraDeletedPageLogEntryRelatedCond(), LogEventsList\getShowHideLinks(), ApiQueryRecentChanges\run(), and LogEventsList\userCanBitfield().

◆ DELETED_USER

const LogPage::DELETED_USER = 4

Definition at line 40 of file LogPage.php.

Referenced by LogPager\enforcePerformerRestrictions(), ApiQueryLogEvents\execute(), ApiQueryLogEvents\extractRowInfo(), ProtectedPagesPager\formatValue(), RevDelLogItem\getApiData(), EditPage\getLastDelete(), LogFormatter\getMessageParameters(), LogFormatter\getPerformerElement(), and XmlDumpWriter\writeLogItem().

◆ SUPPRESSED_ACTION

const LogPage::SUPPRESSED_ACTION = self::DELETED_ACTION | self::DELETED_RESTRICTED

Definition at line 45 of file LogPage.php.

Referenced by LogPager\enforceActionRestrictions(), and LogPager\enforcePerformerRestrictions().

◆ SUPPRESSED_USER

const LogPage::SUPPRESSED_USER = self::DELETED_USER | self::DELETED_RESTRICTED

Definition at line 44 of file LogPage.php.

Referenced by LogPager\enforceActionRestrictions(), and LogPager\enforcePerformerRestrictions().

The documentation for this class was generated from the following file:

includes/logging/LogPage.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ actionText()

◆ addEntry()

◆ addRelations()

◆ extractParams()

◆ getComment()

◆ getDescription()

◆ getName()

◆ getRcComment()

◆ getRcCommentIRC()

◆ getRestriction()

◆ getTitleLink()

◆ isLogType()

◆ isRestricted()

◆ makeParamBlob()

◆ saveContent()

◆ validTypes()

Member Data Documentation

◆ $action

◆ $actionText

◆ $comment

◆ $doer

◆ $ircActionText

◆ $params

◆ $sendToUDP

◆ $target

◆ $type

◆ $updateRecentChanges

◆ DELETED_ACTION

◆ DELETED_COMMENT

◆ DELETED_RESTRICTED

◆ DELETED_USER

◆ SUPPRESSED_ACTION

◆ SUPPRESSED_USER