Class for creating new log entries and inserting them into the database. More...

Inherits MediaWiki\Logging\LogEntryBase, and MediaWiki\ChangeTags\Taggable.

Collaboration diagram for MediaWiki\Logging\ManualLogEntry:

[legend]

Public Member Functions

__construct ( $type, $subtype)

addParameter ( $name, $value)

Add a parameter to the list already set.

addTags ( $tags)

Add change tags for the log entry.

getAssociatedRevId ()

getComment ()

getDeleted ()

getIsPatrollable ()

Whether this log entry is patrollable.

getParameters ()

getPerformerIdentity ()

getRecentChange ( $newId=0)

Get a RecentChanges object for the log entry.

getSubtype ()

getTags ()

getTarget ()

This method will throw if the target page belongs to another wiki.

getTargetPage ()

Get the target page of this action.

getTimestamp ()

getType ()

insert (?IDatabase $dbw=null)

Insert the entry into the logging table.

isLegacy ()

publish ( $newId, $to='rcandudp')

Publish the log entry.

setAssociatedRevId ( $revId)

Set an associated revision id.

setComment (string $comment)

Set a comment associated with the action being logged.

setDeleted ( $deleted)

Set the 'deleted' flag.

setForceBotFlag (bool $forceBotFlag)

Set the bot flag in the recent changes to this value.

setIsPatrollable ( $patrollable)

Set whether this log entry should be made patrollable This shouldn't depend on config, only on whether there is full support in the software for patrolling this log entry.

setLegacy ( $legacy)

Set the 'legacy' flag.

setParameters ( $parameters)

Set extra log parameters.

setPerformer (UserIdentity $performer)

Set the user that performed the action being logged.

setRelations (array $relations)

Declare arbitrary tag/value relations to this log entry.

setTarget ( $target)

Set the title of the object changed.

setTimestamp ( $timestamp)

Set the timestamp of when the logged action took place.

Public Member Functions inherited from MediaWiki\Logging\LogEntryBase

getFullType ()

The full logtype in format maintype/subtype.

Returns: string

isDeleted ( $field)

Parameters

int $field One of LogPage::DELETED_* bitfield constants

Returns: bool

Protected Attributes
string	$comment = ''
	Comment for the log entry.

int null	$deleted
	Deletion state of the log entry.

bool null	$forceBotFlag = null
	The bot flag in the recent changes will be set to this value.

int	$id
	ID of the log entry.

bool	$isPatrollable = false
	Can this log entry be patrolled?

bool	$legacy = false
	Whether this is a legacy log entry.

array	$parameters = []
	Parameters for log entry.

UserIdentity	$performer
	Performer of the action for the log entry.

array	$relations = []

int	$revId = 0
	A rev id associated to the log entry.

string	$subtype
	Sub type of log entry.

string[]	$tags = []
	Change tags add to the log entry.

PageReference	$targetPage
	Target page for the log entry.

string	$timestamp
	Timestamp of creation of the log entry.

string	$type
	Type of log entry.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Logging\LogEntryBase
static	extractParams ( $blob)
	Extract a parameter array from a blob.

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

Detailed Description

Class for creating new log entries and inserting them into the database.

Stability: newable

Note: marked as newable in 1.35 for lack of a better alternative, but should be changed to use the builder pattern or the command pattern.

Since: 1.19

See also: https://www.mediawiki.org/wiki/Manual:Logging_to_Special:Log

Definition at line 45 of file ManualLogEntry.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Logging\ManualLogEntry::__construct	(		$type,
			$subtype )

Stability: stable: to call

Since: 1.19

Parameters

string	$type	Log type. Should match $wgLogTypes.
string	$subtype	Log subtype (action). Should match $wgLogActions or (together with $type) $wgLogActionsHandlers.

Note

Definition at line 99 of file ManualLogEntry.php.

References MediaWiki\Logging\ManualLogEntry\$subtype, and MediaWiki\Logging\ManualLogEntry\$type.

Member Function Documentation

◆ addParameter()

MediaWiki\Logging\ManualLogEntry::addParameter	(		$name,
			$value )

Add a parameter to the list already set.

See also: setParameters

Since: 1.44

Parameters

string	$name
mixed	$value

Definition at line 159 of file ManualLogEntry.php.

◆ addTags()

MediaWiki\Logging\ManualLogEntry::addTags ( $tags )

Add change tags for the log entry.

Since: 1.33

Parameters

string | string[] | null $tags Tags to apply

Implements MediaWiki\ChangeTags\Taggable.

Definition at line 248 of file ManualLogEntry.php.

References MediaWiki\Logging\ManualLogEntry\$tags.

◆ getAssociatedRevId()

MediaWiki\Logging\ManualLogEntry::getAssociatedRevId ( )

Since: 1.27

Returns: int

Definition at line 548 of file ManualLogEntry.php.

◆ getComment()

MediaWiki\Logging\ManualLogEntry::getComment ( )

Returns: string

Implements MediaWiki\Logging\LogEntry.

Definition at line 540 of file ManualLogEntry.php.

◆ getDeleted()

MediaWiki\Logging\ManualLogEntry::getDeleted ( )

Returns: int

Implements MediaWiki\Logging\LogEntry.

Definition at line 581 of file ManualLogEntry.php.

◆ getIsPatrollable()

MediaWiki\Logging\ManualLogEntry::getIsPatrollable ( )

Whether this log entry is patrollable.

Since: 1.27

Returns: bool

Definition at line 566 of file ManualLogEntry.php.

◆ getParameters()

MediaWiki\Logging\ManualLogEntry::getParameters ( )

Returns: array

Implements MediaWiki\Logging\LogEntry.

Definition at line 507 of file ManualLogEntry.php.

◆ getPerformerIdentity()

MediaWiki\Logging\ManualLogEntry::getPerformerIdentity ( )

Since: 1.36

Returns: UserIdentity

Implements MediaWiki\Logging\LogEntry.

Definition at line 511 of file ManualLogEntry.php.

◆ getRecentChange()

MediaWiki\Logging\ManualLogEntry::getRecentChange ( $newId = 0 )

Get a RecentChanges object for the log entry.

Parameters

int $newId

Returns: RecentChange

Since: 1.23

Definition at line 399 of file ManualLogEntry.php.

References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), and MediaWiki\Logging\LogEntryBase\makeParamBlob().

◆ getSubtype()

MediaWiki\Logging\ManualLogEntry::getSubtype ( )

Returns: string

Implements MediaWiki\Logging\LogEntry.

Definition at line 500 of file ManualLogEntry.php.

◆ getTags()

MediaWiki\Logging\ManualLogEntry::getTags ( )

Since: 1.27

Returns: string[]

Definition at line 556 of file ManualLogEntry.php.

◆ getTarget()

MediaWiki\Logging\ManualLogEntry::getTarget ( )

This method will throw if the target page belongs to another wiki.

To avoid problems, use ::getTargetPage() in new code.

Returns: Title

Implements MediaWiki\Logging\LogEntry.

Definition at line 520 of file ManualLogEntry.php.

◆ getTargetPage()

MediaWiki\Logging\ManualLogEntry::getTargetPage ( )

Get the target page of this action.

Since: 1.46

Implements MediaWiki\Logging\LogEntry.

Definition at line 524 of file ManualLogEntry.php.

◆ getTimestamp()

MediaWiki\Logging\ManualLogEntry::getTimestamp ( )

Returns: string|false TS::MW timestamp, a string with 14 digits

Implements MediaWiki\Logging\LogEntry.

Definition at line 531 of file ManualLogEntry.php.

References wfTimestamp(), and wfTimestampNow().

◆ getType()

MediaWiki\Logging\ManualLogEntry::getType ( )

Returns: string

Implements MediaWiki\Logging\LogEntry.

Definition at line 493 of file ManualLogEntry.php.

◆ insert()

MediaWiki\Logging\ManualLogEntry::insert ( ?IDatabase $dbw = null )

Insert the entry into the logging table.

Since 1.46, the provided IDatabase may belong to a different wiki than the current one. In that case it's your responsibility to ensure that the log performer, target, and any parameters are all referring to users, titles, etc. that are valid on that wiki. Publishing such log entries to recent changes (see ::publish()) is not supported.

Returns: int ID of the log entry

Definition at line 313 of file ManualLogEntry.php.

References MediaWiki\Page\PageReference\getDBkey(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Page\PageReference\getNamespace(), MediaWiki\Logging\LogEntryBase\makeParamBlob(), and wfTimestampNow().

◆ isLegacy()

MediaWiki\Logging\ManualLogEntry::isLegacy ( )

Since: 1.25

Returns: bool

Reimplemented from MediaWiki\Logging\LogEntryBase.

Definition at line 574 of file ManualLogEntry.php.

◆ publish()

MediaWiki\Logging\ManualLogEntry::publish	(		$newId,
			$to = 'rcandudp' )

Publish the log entry.

Parameters

int	$newId	Id of the log entry.
string	$to	One of: rcandudp (default), rc, udp

Definition at line 434 of file ManualLogEntry.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ setAssociatedRevId()

MediaWiki\Logging\ManualLogEntry::setAssociatedRevId ( $revId )

Set an associated revision id.

For example, the ID of the revision that was inserted to mark a page move or protection, file upload, etc.

Since: 1.27

Parameters

int $revId

Definition at line 238 of file ManualLogEntry.php.

References MediaWiki\Logging\ManualLogEntry\$revId.

◆ setComment()

MediaWiki\Logging\ManualLogEntry::setComment ( string $comment )

Set a comment associated with the action being logged.

Since: 1.19

Parameters

string $comment

Definition at line 225 of file ManualLogEntry.php.

References MediaWiki\Logging\ManualLogEntry\$comment.

◆ setDeleted()

MediaWiki\Logging\ManualLogEntry::setDeleted ( $deleted )

Set the 'deleted' flag.

Since: 1.19

Parameters

int $deleted One of LogPage::DELETED_* bitfield constants

Definition at line 289 of file ManualLogEntry.php.

References MediaWiki\Logging\ManualLogEntry\$deleted.

◆ setForceBotFlag()

MediaWiki\Logging\ManualLogEntry::setForceBotFlag ( bool $forceBotFlag )

Set the bot flag in the recent changes to this value.

Since: 1.40 (also backported to 1.39.14)

Parameters

bool $forceBotFlag

Definition at line 299 of file ManualLogEntry.php.

◆ setIsPatrollable()

MediaWiki\Logging\ManualLogEntry::setIsPatrollable ( $patrollable )

Set whether this log entry should be made patrollable This shouldn't depend on config, only on whether there is full support in the software for patrolling this log entry.

False by default

Since: 1.27

Parameters

bool $patrollable

Definition at line 269 of file ManualLogEntry.php.

◆ setLegacy()

MediaWiki\Logging\ManualLogEntry::setLegacy ( $legacy )

Set the 'legacy' flag.

Since: 1.25

Parameters

bool $legacy

Definition at line 279 of file ManualLogEntry.php.

References MediaWiki\Logging\ManualLogEntry\$legacy.

◆ setParameters()

MediaWiki\Logging\ManualLogEntry::setParameters ( $parameters )

Set extra log parameters.

Takes an array in a parameter name => parameter value format. The array will be converted to string via serialize() and stored in the log_params database field. (If you want to store parameters in such a way that they can be targeted by DB queries, use setRelations() instead.)

You can pass these parameters to the log action message by prefixing the keys with a number and optional type, using colons to separate the fields. The numbering should start with number 4 (matching the $4 message parameter), as the first three parameters are hardcoded for every message ($1 is a link to the username and user talk page of the performing user, $2 is just the username (for determining gender), $3 is a link to the target page).

If you want to store stuff that should not be available in messages, don't prefix the array key with a number and don't use the colons. (Note that such parameters will still be publicly viewable via the API.)

Example: $entry->setParameters( [ // store and use in messages as $4 '4::color' => 'blue', // store as is, use in messages as $5 with Message::numParam() '5:number:count' => 3000, // store but do not use in messages 'animal' => 'dog' ] );

Typically, these parameters will be used in the logentry-<type>-<subtype> message, but custom formatters, declared via $wgLogActionsHandlers, can override that.

Since: 1.19

Parameters

array $parameters Associative array

See also: LogFormatter::formatParameterValue() for valid parameter types and their meanings.; self::setRelations() for storing parameters in a way that can be searched.; LogFormatter::getMessageKey() for determining which message these parameters will be used in.

Definition at line 146 of file ManualLogEntry.php.

References MediaWiki\Logging\ManualLogEntry\$parameters.

◆ setPerformer()

MediaWiki\Logging\ManualLogEntry::setPerformer ( UserIdentity $performer )

Set the user that performed the action being logged.

Since 1.46, the user can belong to another wiki, not just the current one. The database passed to ::insert() must belong to the same wiki.

Parameters

UserIdentity $performer

Since: 1.19

Definition at line 185 of file ManualLogEntry.php.

References MediaWiki\Logging\ManualLogEntry\$performer.

◆ setRelations()

MediaWiki\Logging\ManualLogEntry::setRelations ( array $relations )

Declare arbitrary tag/value relations to this log entry.

These will be stored in the log_search table and can be used to filter log entries later on.

Parameters

array $relations Map of (tag => (list of values|value)); values must be string. When an array of values is given, a separate DB row will be created for each value.

Since: 1.22

Definition at line 172 of file ManualLogEntry.php.

References MediaWiki\Logging\ManualLogEntry\$relations.

◆ setTarget()

MediaWiki\Logging\ManualLogEntry::setTarget ( $target )

Set the title of the object changed.

Since 1.46, the page can belong to another wiki, not just the current one. The database passed to ::insert() must belong to the same wiki.

Parameters

LinkTarget | PageReference $target calling with LinkTarget is deprecated since 1.37

Since: 1.19

Definition at line 199 of file ManualLogEntry.php.

◆ setTimestamp()

MediaWiki\Logging\ManualLogEntry::setTimestamp ( $timestamp )

Set the timestamp of when the logged action took place.

Since: 1.19

Parameters

string $timestamp Can be in any format accepted by ConvertibleTimestamp

Definition at line 215 of file ManualLogEntry.php.

References MediaWiki\Logging\ManualLogEntry\$timestamp.

Member Data Documentation

◆ $comment

string MediaWiki\Logging\ManualLogEntry::$comment = ''

protected

Comment for the log entry.

Definition at line 68 of file ManualLogEntry.php.

Referenced by MediaWiki\Logging\ManualLogEntry\setComment().

◆ $deleted

int null MediaWiki\Logging\ManualLogEntry::$deleted

protected

Deletion state of the log entry.

Definition at line 77 of file ManualLogEntry.php.

Referenced by MediaWiki\Logging\ManualLogEntry\setDeleted().

◆ $forceBotFlag

bool null MediaWiki\Logging\ManualLogEntry::$forceBotFlag = null

protected

The bot flag in the recent changes will be set to this value.

Definition at line 89 of file ManualLogEntry.php.

◆ $id

int MediaWiki\Logging\ManualLogEntry::$id

protected

ID of the log entry.

Definition at line 80 of file ManualLogEntry.php.

◆ $isPatrollable

bool MediaWiki\Logging\ManualLogEntry::$isPatrollable = false

protected

Can this log entry be patrolled?

Definition at line 83 of file ManualLogEntry.php.

◆ $legacy

bool MediaWiki\Logging\ManualLogEntry::$legacy = false

protected

Whether this is a legacy log entry.

Definition at line 86 of file ManualLogEntry.php.

Referenced by MediaWiki\Logging\ManualLogEntry\setLegacy().

◆ $parameters

array MediaWiki\Logging\ManualLogEntry::$parameters = []

protected

Parameters for log entry.

Definition at line 53 of file ManualLogEntry.php.

Referenced by MediaWiki\Logging\ManualLogEntry\setParameters().

◆ $performer

UserIdentity MediaWiki\Logging\ManualLogEntry::$performer

protected

Performer of the action for the log entry.

Definition at line 59 of file ManualLogEntry.php.

Referenced by MediaWiki\Logging\ManualLogEntry\setPerformer().

◆ $relations

array MediaWiki\Logging\ManualLogEntry::$relations = []

protected

Definition at line 56 of file ManualLogEntry.php.

Referenced by MediaWiki\Logging\ManualLogEntry\setRelations().

◆ $revId

int MediaWiki\Logging\ManualLogEntry::$revId = 0

protected

A rev id associated to the log entry.

Definition at line 71 of file ManualLogEntry.php.

Referenced by MediaWiki\Logging\ManualLogEntry\setAssociatedRevId().

◆ $subtype

string MediaWiki\Logging\ManualLogEntry::$subtype

protected

Sub type of log entry.

Definition at line 50 of file ManualLogEntry.php.

Referenced by MediaWiki\Logging\ManualLogEntry\__construct().

◆ $tags

string [] MediaWiki\Logging\ManualLogEntry::$tags = []

protected

Change tags add to the log entry.

Definition at line 74 of file ManualLogEntry.php.

Referenced by MediaWiki\Logging\ManualLogEntry\addTags().

◆ $targetPage

PageReference MediaWiki\Logging\ManualLogEntry::$targetPage

protected

Target page for the log entry.

Definition at line 62 of file ManualLogEntry.php.

◆ $timestamp

string MediaWiki\Logging\ManualLogEntry::$timestamp

protected

Timestamp of creation of the log entry.

Definition at line 65 of file ManualLogEntry.php.

Referenced by MediaWiki\Logging\ManualLogEntry\setTimestamp().

◆ $type

string MediaWiki\Logging\ManualLogEntry::$type

protected

Type of log entry.

Definition at line 47 of file ManualLogEntry.php.

Referenced by MediaWiki\Logging\ManualLogEntry\__construct().

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

includes/Logging/ManualLogEntry.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addParameter()

◆ addTags()

◆ getAssociatedRevId()

◆ getComment()

◆ getDeleted()

◆ getIsPatrollable()

◆ getParameters()

◆ getPerformerIdentity()

◆ getRecentChange()

◆ getSubtype()

◆ getTags()

◆ getTarget()

◆ getTargetPage()

◆ getTimestamp()

◆ getType()

◆ insert()

◆ isLegacy()

◆ publish()

◆ setAssociatedRevId()

◆ setComment()

◆ setDeleted()

◆ setForceBotFlag()

◆ setIsPatrollable()

◆ setLegacy()

◆ setParameters()

◆ setPerformer()

◆ setRelations()

◆ setTarget()

◆ setTimestamp()

Member Data Documentation

◆ $comment

◆ $deleted

◆ $forceBotFlag

◆ $id

◆ $isPatrollable

◆ $legacy

◆ $parameters

◆ $performer

◆ $relations

◆ $revId

◆ $subtype

◆ $tags

◆ $targetPage

◆ $timestamp

◆ $type