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

Public Member Functions
	__construct ( $type, $rc=true, $udp='skipUDP')

	addEntry ( $action, $target, $comment, $params, $performer)
	Add a log entry. More...

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

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

	getDescription ()
	Description of this log type. More...

	getName ()
	Name of the log. More...

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

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

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

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

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

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

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

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

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

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 ()

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.

Stability: newable

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

Definition at line 41 of file LogPage.php.

Constructor & Destructor Documentation

◆ __construct()

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

Stability: 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 92 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
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
bool	$filterWikilinks	Whether to filter wiki links

Returns: string HTML

Definition at line 238 of file LogPage.php.

References $title, $wgLang, wfDebug(), and wfMessage().

Referenced by LegacyLogFormatter\getActionMessage().

◆ addEntry()

LogPage::addEntry	(	$action,
		$target,
		$comment,
		$params,
		$performer
	)

Add a log entry.

Parameters

string	$action	One of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move', 'move_redir'
Title	$target
string \| null	$comment	Description associated
array	$params	Parameters passed later to wfMessage function
int \| UserIdentity	$performer	The user doing the action, or their user id. Calling with user ID is deprecated since 1.36.

Returns: int The log_id of the inserted log entry

Definition at line 345 of file LogPage.php.

References RequestContext\newExtraneousContext(), LogFormatter\newFromEntry(), and User\newFromId().

◆ addRelations()

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

Add relations to log_search table.

Parameters

string	$field
array	$values
int	$logid

Returns: bool

Definition at line 392 of file LogPage.php.

References DB_PRIMARY, and wfGetDB().

◆ extractParams()

static LogPage::extractParams ( $blob )

static

Extract a parameter array from a blob.

Parameters

string $blob

Returns: array

Definition at line 429 of file LogPage.php.

References $blob.

Referenced by DatabaseLogEntry\getParameters().

◆ getComment()

LogPage::getComment ( )

Get the comment from the last addEntry() call.

Returns: string

Definition at line 200 of file LogPage.php.

◆ getDescription()

LogPage::getDescription ( )

Description of this log type.

Returns: Message

Since: 1.19

Definition at line 456 of file LogPage.php.

References $type, and wfMessage().

◆ getName()

LogPage::getName ( )

Name of the log.

Returns: Message

Since: 1.19

Definition at line 442 of file LogPage.php.

References $type, and wfMessage().

◆ getRcComment()

LogPage::getRcComment ( )

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

Returns: string

Definition at line 161 of file LogPage.php.

References wfMessage().

Referenced by saveContent().

◆ getRcCommentIRC()

LogPage::getRcCommentIRC ( )

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

Returns: string

Definition at line 181 of file LogPage.php.

References wfMessage().

Referenced by saveContent().

◆ getRestriction()

LogPage::getRestriction ( )

Returns the right needed to read this log type.

Returns: string

Since: 1.19

Definition at line 469 of file LogPage.php.

References $type.

◆ isLogType()

static LogPage::isLogType ( $type )

static

Is $type a valid log type.

Parameters

string $type Log type to check

Returns: bool

Definition at line 221 of file LogPage.php.

References $type.

Referenced by MediaWiki\Specials\SpecialLog\execute().

◆ isRestricted()

LogPage::isRestricted ( )

Tells if this log is not viewable by all.

Returns: bool

Since: 1.19

Definition at line 481 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 419 of file LogPage.php.

◆ saveContent()

LogPage::saveContent ( )

protected

Returns: int The log_id of the inserted log entry

Definition at line 101 of file LogPage.php.

References DB_PRIMARY, getRcComment(), getRcCommentIRC(), SpecialPage\getTitleFor(), RecentChange\newLogEntry(), RecentChange\notifyLog(), wfGetDB(), and wfTimestampNow().

◆ validTypes()

static LogPage::validTypes ( )

static

Get the list of valid log types.

Returns: string[]

Definition at line 209 of file LogPage.php.

Referenced by ApiQueryLogEvents\getAllowedParams(), MediaWiki\Specials\Redirects\SpecialMylog\getSubpagesForPrefixSearch(), and MediaWiki\Specials\SpecialLog\getSubpagesForPrefixSearch().

Member Data Documentation

◆ $sendToUDP

bool LogPage::$sendToUDP

Definition at line 55 of file LogPage.php.

◆ $updateRecentChanges

bool LogPage::$updateRecentChanges

Definition at line 52 of file LogPage.php.

◆ DELETED_ACTION

const LogPage::DELETED_ACTION = 1

Definition at line 42 of file LogPage.php.

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

◆ DELETED_COMMENT

const LogPage::DELETED_COMMENT = 2

Definition at line 43 of file LogPage.php.

Referenced by ProtectedPagesPager\formatValue(), RevDelLogItem\getApiData(), LogFormatter\getComment(), and XmlDumpWriter\writeLogItem().

◆ DELETED_RESTRICTED

const LogPage::DELETED_RESTRICTED = 8

Definition at line 45 of file LogPage.php.

Referenced by SpecialWatchlist\doMainQuery(), ApiQueryLogEvents\execute(), ApiQueryRecentChanges\run(), LogFormatter\styleRestrictedElement(), and LogEventsList\userCanBitfield().

◆ DELETED_USER

const LogPage::DELETED_USER = 4

Definition at line 44 of file LogPage.php.

Referenced by ApiQueryLogEvents\execute(), ProtectedPagesPager\formatValue(), RevDelLogItem\getApiData(), LogFormatter\getMessageParameters(), LogFormatter\getPerformerElement(), and XmlDumpWriter\writeLogItem().

◆ SUPPRESSED_ACTION

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

Definition at line 49 of file LogPage.php.

◆ SUPPRESSED_USER

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

Definition at line 48 of file LogPage.php.

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

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ actionText()

◆ addEntry()

◆ addRelations()

◆ extractParams()

◆ getComment()

◆ getDescription()

◆ getName()

◆ getRcComment()

◆ getRcCommentIRC()

◆ getRestriction()

◆ isLogType()

◆ isRestricted()

◆ makeParamBlob()

◆ saveContent()

◆ validTypes()

Member Data Documentation

◆ $sendToUDP

◆ $updateRecentChanges

◆ DELETED_ACTION

◆ DELETED_COMMENT

◆ DELETED_RESTRICTED

◆ DELETED_USER

◆ SUPPRESSED_ACTION

◆ SUPPRESSED_USER