Class for creating log entries manually, to inject them into the database. More...

Inheritance diagram for ManualLogEntry:

[legend]

Collaboration diagram for ManualLogEntry:

[legend]

Public Member Functions
	__construct ( $type, $subtype)

	getAssociatedRevId ()

	getComment ()
	Get the user provided comment.

	getDeleted ()
	Get the access restriction.

	getIsPatrollable ()
	Whether this log entry is patrollable.

	getParameters ()
	Get the extra parameters stored for this message.

	getPerformer ()

	getRecentChange ( $newId=0)
	Get a RecentChanges object for the log entry.

	getSubtype ()
	The log subtype.

	getTags ()

	getTarget ()

	getTimestamp ()
	Get the timestamp when the action was executed.

	getType ()
	The main log type.

	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 ( $comment)
	Set a comment associated with the action being logged.

	setDeleted ( $deleted)
	Set the 'deleted' flag.

	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 (User $performer)
	Set the user that performed the action being logged.

	setRelations (array $relations)
	Declare arbitrary tag/value relations to this log entry.

	setTags ( $tags)
	Set change tags for the log entry.

	setTarget (Title $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 LogEntryBase
	getFullType ()
	The full logtype in format maintype/subtype.

	isDeleted ( $field)

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

int	$deleted
	Deletion state of the log entry.

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.

User	$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.

array	$tags = null
	Change tags add to the log entry.

Title	$target
	Target title 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 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 log entries manually, to inject them into the database.

Since: 1.19

Definition at line 400 of file LogEntry.php.

Constructor & Destructor Documentation

◆ __construct()

ManualLogEntry::__construct	(		$type,
			$subtype )

Since: 1.19

Parameters

string	$type
string	$subtype

Definition at line 448 of file LogEntry.php.

References $subtype, $type, and type.

Member Function Documentation

◆ getAssociatedRevId()

ManualLogEntry::getAssociatedRevId ( )

Since: 1.27

Returns: int

Definition at line 780 of file LogEntry.php.

References $revId.

Referenced by insert().

◆ getComment()

ManualLogEntry::getComment ( )

Get the user provided comment.

Returns: string

Implements LogEntry.

Definition at line 772 of file LogEntry.php.

References $comment.

Referenced by insert().

◆ getDeleted()

ManualLogEntry::getDeleted ( )

Get the access restriction.

Returns: string

Implements LogEntry.

Definition at line 810 of file LogEntry.php.

References $deleted.

◆ getIsPatrollable()

ManualLogEntry::getIsPatrollable ( )

Whether this log entry is patrollable.

Since: 1.27

Returns: bool

Definition at line 798 of file LogEntry.php.

References $isPatrollable.

Referenced by publish().

◆ getParameters()

ManualLogEntry::getParameters ( )

Get the extra parameters stored for this message.

Returns: array

Implements LogEntry.

Definition at line 748 of file LogEntry.php.

References $parameters.

Referenced by insert().

◆ getPerformer()

ManualLogEntry::getPerformer ( )

Returns: User

Implements LogEntry.

Definition at line 755 of file LogEntry.php.

References $performer.

Referenced by getRecentChange(), insert(), and publish().

◆ getRecentChange()

ManualLogEntry::getRecentChange ( $newId = 0 )

Get a RecentChanges object for the log entry.

Parameters

int $newId

Returns: RecentChange

Since: 1.23

Definition at line 666 of file LogEntry.php.

References $context, getPerformer(), getTarget(), getTimestamp(), SpecialPage\getTitleFor(), getType(), LogEntryBase\makeParamBlob(), RequestContext\newExtraneousContext(), LogFormatter\newFromEntry(), and RecentChange\newLogEntry().

Referenced by publish().

◆ getSubtype()

ManualLogEntry::getSubtype ( )

The log subtype.

Returns: string

Implements LogEntry.

Definition at line 744 of file LogEntry.php.

References $subtype.

Referenced by insert().

◆ getTags()

ManualLogEntry::getTags ( )

Since: 1.27

Returns: array

Definition at line 788 of file LogEntry.php.

References $tags.

Referenced by publish().

◆ getTarget()

ManualLogEntry::getTarget ( )

Returns: Title

Implements LogEntry.

Definition at line 762 of file LogEntry.php.

References $target.

Referenced by getRecentChange(), and insert().

◆ getTimestamp()

ManualLogEntry::getTimestamp ( )

Get the timestamp when the action was executed.

Returns: string

Implements LogEntry.

Definition at line 766 of file LogEntry.php.

References wfTimestamp(), and wfTimestampNow().

Referenced by getRecentChange(), and insert().

◆ getType()

ManualLogEntry::getType ( )

The main log type.

Returns: string

Implements LogEntry.

Definition at line 740 of file LogEntry.php.

References $type.

Referenced by getRecentChange(), insert(), and publish().

◆ insert()

ManualLogEntry::insert ( IDatabase $dbw = null )

Insert the entry into the logging table.

Parameters

IDatabase $dbw

Returns: int ID of the log entry

Exceptions

MWException

Definition at line 595 of file LogEntry.php.

References $comment, $deleted, $id, $params, $relations, $revId, $rows, $value, DB_MASTER, getAssociatedRevId(), getComment(), getParameters(), getPerformer(), getSubtype(), getTarget(), getTimestamp(), getType(), LogEntryBase\makeParamBlob(), CommentStore\newKey(), wfGetDB(), and wfTimestampNow().

◆ isLegacy()

ManualLogEntry::isLegacy ( )

Since: 1.25

Returns: bool

Reimplemented from LogEntryBase.

Definition at line 806 of file LogEntry.php.

References $legacy.

◆ publish()

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 706 of file LogEntry.php.

References $tags, DB_MASTER, getIsPatrollable(), getPerformer(), getRecentChange(), getTags(), getType(), PatrolLog\record(), and wfGetDB().

◆ setAssociatedRevId()

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 538 of file LogEntry.php.

References $revId.

◆ setComment()

ManualLogEntry::setComment ( $comment )

Set a comment associated with the action being logged.

Since: 1.19

Parameters

string $comment

Definition at line 525 of file LogEntry.php.

References $comment.

◆ setDeleted()

ManualLogEntry::setDeleted ( $deleted )

Set the 'deleted' flag.

Since: 1.19

Parameters

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

Definition at line 584 of file LogEntry.php.

References $deleted.

◆ setIsPatrollable()

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 564 of file LogEntry.php.

◆ setLegacy()

ManualLogEntry::setLegacy ( $legacy )

Set the 'legacy' flag.

Since: 1.25

Parameters

bool $legacy

Definition at line 574 of file LogEntry.php.

References $legacy.

◆ setParameters()

ManualLogEntry::setParameters ( $parameters )

Set extra log parameters.

You can pass params 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, the first three parameters are hardcoded for every message.

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.

Example: $entry->setParameters( '4color' => 'blue', '5:number:count' => 3000, 'animal' => 'dog' );

Since: 1.19

Parameters

array $parameters Associative array

Definition at line 474 of file LogEntry.php.

References $parameters.

◆ setPerformer()

ManualLogEntry::setPerformer ( User $performer )

Set the user that performed the action being logged.

Since: 1.19

Parameters

User $performer

Definition at line 495 of file LogEntry.php.

References $performer.

Referenced by EditPage\addContentModelChangeLogEntry(), and SpecialChangeContentModel\onSubmit().

◆ setRelations()

ManualLogEntry::setRelations ( array $relations )

Declare arbitrary tag/value relations to this log entry.

These can be used to filter log entries later on.

Parameters

array $relations Map of (tag => (list of values|value))

Since: 1.22

Definition at line 485 of file LogEntry.php.

References $relations.

◆ setTags()

ManualLogEntry::setTags ( $tags )

Set change tags for the log entry.

Since: 1.27

Parameters

string | string[] $tags

Definition at line 548 of file LogEntry.php.

References $tags.

◆ setTarget()

ManualLogEntry::setTarget ( Title $target )

Set the title of the object changed.

Since: 1.19

Parameters

Title $target

Definition at line 505 of file LogEntry.php.

References $target.

◆ setTimestamp()

ManualLogEntry::setTimestamp ( $timestamp )

Set the timestamp of when the logged action took place.

Since: 1.19

Parameters

string $timestamp

Definition at line 515 of file LogEntry.php.

References $timestamp.

Referenced by LocalFile\recordUpload2().

Member Data Documentation

◆ $comment

string ManualLogEntry::$comment = ''

protected

Comment for the log entry.

Definition at line 423 of file LogEntry.php.

Referenced by getComment(), insert(), and setComment().

◆ $deleted

int ManualLogEntry::$deleted

protected

Deletion state of the log entry.

Definition at line 432 of file LogEntry.php.

Referenced by getDeleted(), insert(), and setDeleted().

◆ $id

int ManualLogEntry::$id

protected

ID of the log entry.

Definition at line 435 of file LogEntry.php.

Referenced by insert().

◆ $isPatrollable

bool ManualLogEntry::$isPatrollable = false

protected

Can this log entry be patrolled?

Definition at line 438 of file LogEntry.php.

Referenced by getIsPatrollable().

◆ $legacy

bool ManualLogEntry::$legacy = false

protected

Whether this is a legacy log entry.

Definition at line 441 of file LogEntry.php.

Referenced by isLegacy(), and setLegacy().

◆ $parameters

array ManualLogEntry::$parameters = []

protected

Parameters for log entry.

Definition at line 408 of file LogEntry.php.

Referenced by getParameters(), and setParameters().

◆ $performer

User ManualLogEntry::$performer

protected

Performer of the action for the log entry.

Definition at line 414 of file LogEntry.php.

Referenced by getPerformer(), and setPerformer().

◆ $relations

array ManualLogEntry::$relations = []

protected

Definition at line 411 of file LogEntry.php.

Referenced by insert(), and setRelations().

◆ $revId

int ManualLogEntry::$revId = 0

protected

A rev id associated to the log entry.

Definition at line 426 of file LogEntry.php.

Referenced by getAssociatedRevId(), insert(), and setAssociatedRevId().

◆ $subtype

string ManualLogEntry::$subtype

protected

Sub type of log entry.

Definition at line 405 of file LogEntry.php.

Referenced by __construct(), and getSubtype().

◆ $tags

array ManualLogEntry::$tags = null

protected

Change tags add to the log entry.

Definition at line 429 of file LogEntry.php.

Referenced by getTags(), publish(), and setTags().

◆ $target

Title ManualLogEntry::$target

protected

Target title for the log entry.

Definition at line 417 of file LogEntry.php.

Referenced by getTarget(), and setTarget().

◆ $timestamp

string ManualLogEntry::$timestamp

protected

Timestamp of creation of the log entry.

Definition at line 420 of file LogEntry.php.

Referenced by setTimestamp().

◆ $type

string ManualLogEntry::$type

protected

Type of log entry.

Definition at line 402 of file LogEntry.php.

Referenced by __construct(), and getType().

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

includes/logging/LogEntry.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAssociatedRevId()

◆ getComment()

◆ getDeleted()

◆ getIsPatrollable()

◆ getParameters()

◆ getPerformer()

◆ getRecentChange()

◆ getSubtype()

◆ getTags()

◆ getTarget()

◆ getTimestamp()

◆ getType()

◆ insert()

◆ isLegacy()

◆ publish()

◆ setAssociatedRevId()

◆ setComment()

◆ setDeleted()

◆ setIsPatrollable()

◆ setLegacy()

◆ setParameters()

◆ setPerformer()

◆ setRelations()

◆ setTags()

◆ setTarget()

◆ setTimestamp()

Member Data Documentation

◆ $comment

◆ $deleted

◆ $id

◆ $isPatrollable

◆ $legacy

◆ $parameters

◆ $performer

◆ $relations

◆ $revId

◆ $subtype

◆ $tags

◆ $target

◆ $timestamp

◆ $type