MediaWiki  REL1_31
ManualLogEntry Class Reference

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

Inheritance diagram for ManualLogEntry:
Collaboration diagram for ManualLogEntry:

Public Member Functions

 __construct ( $type, $subtype)
 
 getAssociatedRevId ()
 
 getComment ()
 Get the user provided comment. More...
 
 getDeleted ()
 Get the access restriction. More...
 
 getIsPatrollable ()
 Whether this log entry is patrollable. More...
 
 getParameters ()
 Get the extra parameters stored for this message. More...
 
 getPerformer ()
 
 getRecentChange ( $newId=0)
 Get a RecentChanges object for the log entry. More...
 
 getSubtype ()
 The log subtype. More...
 
 getTags ()
 
 getTarget ()
 
 getTimestamp ()
 Get the timestamp when the action was executed. More...
 
 getType ()
 The main log type. More...
 
 insert (IDatabase $dbw=null)
 Insert the entry into the logging table. More...
 
 isLegacy ()
 
 publish ( $newId, $to='rcandudp')
 Publish the log entry. More...
 
 setAssociatedRevId ( $revId)
 Set an associated revision id. More...
 
 setComment ( $comment)
 Set a comment associated with the action being logged. More...
 
 setDeleted ( $deleted)
 Set the 'deleted' flag. More...
 
 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. More...
 
 setLegacy ( $legacy)
 Set the 'legacy' flag. More...
 
 setParameters ( $parameters)
 Set extra log parameters. More...
 
 setPerformer (User $performer)
 Set the user that performed the action being logged. More...
 
 setRelations (array $relations)
 Declare arbitrary tag/value relations to this log entry. More...
 
 setTags ( $tags)
 Set change tags for the log entry. More...
 
 setTarget (Title $target)
 Set the title of the object changed. More...
 
 setTimestamp ( $timestamp)
 Set the timestamp of when the logged action took place. More...
 
- Public Member Functions inherited from LogEntryBase
 getFullType ()
 The full logtype in format maintype/subtype. More...
 
 isDeleted ( $field)
 

Protected Attributes

string $comment = ''
 Comment for the log entry. More...
 
int $deleted
 Deletion state of the log entry. More...
 
int $id
 ID of the log entry. More...
 
bool $isPatrollable = false
 Can this log entry be patrolled? More...
 
bool $legacy = false
 Whether this is a legacy log entry. More...
 
array $parameters = []
 Parameters for log entry. More...
 
User $performer
 Performer of the action for the log entry. More...
 
array $relations = []
 
int $revId = 0
 A rev id associated to the log entry. More...
 
string $subtype
 Sub type of log entry. More...
 
array $tags = null
 Change tags add to the log entry. More...
 
Title $target
 Target title for the log entry. More...
 
string $timestamp
 Timestamp of creation of the log entry. More...
 
string $type
 Type of log entry. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from LogEntryBase
static extractParams ( $blob)
 Extract a parameter array from a blob. More...
 
static makeParamBlob ( $params)
 Create a blob from a parameter array. More...
 

Detailed Description

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

Since
1.19

Definition at line 432 of file LogEntry.php.

Constructor & Destructor Documentation

◆ __construct()

ManualLogEntry::__construct (   $type,
  $subtype 
)
Since
1.19
Parameters
string$type
string$subtype

Definition at line 480 of file LogEntry.php.

References $subtype, $type, and type.

Member Function Documentation

◆ getAssociatedRevId()

ManualLogEntry::getAssociatedRevId ( )
Since
1.27
Returns
int

Definition at line 832 of file LogEntry.php.

References $revId.

Referenced by insert().

◆ getComment()

ManualLogEntry::getComment ( )

Get the user provided comment.

Returns
string

Implements LogEntry.

Definition at line 824 of file LogEntry.php.

References $comment.

Referenced by insert().

◆ getDeleted()

ManualLogEntry::getDeleted ( )

Get the access restriction.

Returns
string

Implements LogEntry.

Definition at line 862 of file LogEntry.php.

References $deleted.

◆ getIsPatrollable()

ManualLogEntry::getIsPatrollable ( )

Whether this log entry is patrollable.

Since
1.27
Returns
bool

Definition at line 850 of file LogEntry.php.

References $isPatrollable.

◆ getParameters()

ManualLogEntry::getParameters ( )

Get the extra parameters stored for this message.

Returns
array

Implements LogEntry.

Definition at line 800 of file LogEntry.php.

References $parameters.

Referenced by insert().

◆ getPerformer()

ManualLogEntry::getPerformer ( )
Returns
User

Implements LogEntry.

Definition at line 807 of file LogEntry.php.

References $performer.

Referenced by getRecentChange(), and insert().

◆ getRecentChange()

ManualLogEntry::getRecentChange (   $newId = 0)

Get a RecentChanges object for the log entry.

Parameters
int$newId
Returns
RecentChange
Since
1.23

Definition at line 725 of file LogEntry.php.

References $context, $user, getPerformer(), getTarget(), getTimestamp(), SpecialPage\getTitleFor(), getType(), IP\isIPAddress(), 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 796 of file LogEntry.php.

References $subtype.

Referenced by insert().

◆ getTags()

ManualLogEntry::getTags ( )
Since
1.27
Returns
array

Definition at line 840 of file LogEntry.php.

References $tags.

Referenced by publish().

◆ getTarget()

ManualLogEntry::getTarget ( )
Returns
Title

Implements LogEntry.

Definition at line 814 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 818 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 792 of file LogEntry.php.

References $type.

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

◆ insert()

◆ isLegacy()

ManualLogEntry::isLegacy ( )
Since
1.25
Returns
bool

Reimplemented from LogEntryBase.

Definition at line 858 of file LogEntry.php.

References $legacy.

◆ publish()

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

Publish the log entry.

Parameters
int$newIdId of the log entry.
string$toOne of: rcandudp (default), rc, udp

Definition at line 765 of file LogEntry.php.

References $tags, DeferredUpdates\addCallableUpdate(), DB_MASTER, getRecentChange(), getTags(), getType(), DeferredUpdates\POSTSEND, use, 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 570 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 557 of file LogEntry.php.

References $comment.

◆ setDeleted()

ManualLogEntry::setDeleted (   $deleted)

Set the 'deleted' flag.

Since
1.19
Parameters
int$deletedOne of LogPage::DELETED_* bitfield constants

Definition at line 616 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 596 of file LogEntry.php.

◆ setLegacy()

ManualLogEntry::setLegacy (   $legacy)

Set the 'legacy' flag.

Since
1.25
Parameters
bool$legacy

Definition at line 606 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$parametersAssociative array

Definition at line 506 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 527 of file LogEntry.php.

References $performer.

◆ 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$relationsMap of (tag => (list of values|value))
Since
1.22

Definition at line 517 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 580 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 537 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 547 of file LogEntry.php.

References $timestamp.

Member Data Documentation

◆ $comment

string ManualLogEntry::$comment = ''
protected

Comment for the log entry.

Definition at line 455 of file LogEntry.php.

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

◆ $deleted

int ManualLogEntry::$deleted
protected

Deletion state of the log entry.

Definition at line 464 of file LogEntry.php.

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

◆ $id

int ManualLogEntry::$id
protected

ID of the log entry.

Definition at line 467 of file LogEntry.php.

Referenced by insert().

◆ $isPatrollable

bool ManualLogEntry::$isPatrollable = false
protected

Can this log entry be patrolled?

Definition at line 470 of file LogEntry.php.

Referenced by getIsPatrollable().

◆ $legacy

bool ManualLogEntry::$legacy = false
protected

Whether this is a legacy log entry.

Definition at line 473 of file LogEntry.php.

Referenced by isLegacy(), and setLegacy().

◆ $parameters

array ManualLogEntry::$parameters = []
protected

Parameters for log entry.

Definition at line 440 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 446 of file LogEntry.php.

Referenced by getPerformer(), and setPerformer().

◆ $relations

array ManualLogEntry::$relations = []
protected

Definition at line 443 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 458 of file LogEntry.php.

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

◆ $subtype

string ManualLogEntry::$subtype
protected

Sub type of log entry.

Definition at line 437 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 461 of file LogEntry.php.

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

◆ $target

Title ManualLogEntry::$target
protected

Target title for the log entry.

Definition at line 449 of file LogEntry.php.

Referenced by getTarget(), and setTarget().

◆ $timestamp

string ManualLogEntry::$timestamp
protected

Timestamp of creation of the log entry.

Definition at line 452 of file LogEntry.php.

Referenced by setTimestamp().

◆ $type

string ManualLogEntry::$type
protected

Type of log entry.

Definition at line 434 of file LogEntry.php.

Referenced by __construct(), and getType().


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