MediaWiki  master
PatrolLog Class Reference

Class containing static functions for working with logs of patrol events. More...

Static Public Member Functions

static record ( $rc, $auto=false, User $user=null, $tags=null)
 Record a log event for a change being patrolled. More...
 

Static Private Member Functions

static buildParams ( $change, $auto)
 Prepare log parameters for a patrolled change. More...
 

Detailed Description

Class containing static functions for working with logs of patrol events.

Definition at line 29 of file PatrolLog.php.

Member Function Documentation

◆ buildParams()

static PatrolLog::buildParams (   $change,
  $auto 
)
staticprivate

Prepare log parameters for a patrolled change.

Parameters
RecentChange$changeRecentChange to represent
bool$autoWhether the patrol event was automatic
Returns
array

Definition at line 82 of file PatrolLog.php.

◆ record()

static PatrolLog::record (   $rc,
  $auto = false,
User  $user = null,
  $tags = null 
)
static

Record a log event for a change being patrolled.

Parameters
int | RecentChange$rcChange identifier or RecentChange object
bool$autoWas this patrol event automatic?
User | null$userUser performing the action or null to use $wgUser
string|string[]|null$tags Change tags to add to the patrol log entry ($user should be able to add the specified tags before this is called)
Returns
bool

Definition at line 42 of file PatrolLog.php.

References $user, and RecentChange\newFromId().

Referenced by RecentChange\doMarkPatrolled().


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