MediaWiki master
|
Class for creating new log entries and inserting them into the database. More...
Inherits LogEntryBase, and MediaWiki\ChangeTags\Taggable.
Public Member Functions | |
__construct ( $type, $subtype) | |
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 () | |
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. | |
![]() | |
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. | |
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. | |
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 | extractParams ( $blob) |
Extract a parameter array from a blob. | |
static | makeParamBlob ( $params) |
Create a blob from a parameter array. | |
Class for creating new log entries and inserting them into the database.
Definition at line 48 of file ManualLogEntry.php.
ManualLogEntry::__construct | ( | $type, | |
$subtype | |||
) |
string | $type | Log type. Should match $wgLogTypes. |
string | $subtype | Log subtype (action). Should match $wgLogActions or (together with $type) $wgLogActionsHandlers. |
Definition at line 102 of file ManualLogEntry.php.
ManualLogEntry::addTags | ( | $tags | ) |
Add change tags for the log entry.
string | string[] | null | $tags | Tags to apply |
Implements MediaWiki\ChangeTags\Taggable.
Definition at line 232 of file ManualLogEntry.php.
ManualLogEntry::getAssociatedRevId | ( | ) |
ManualLogEntry::getComment | ( | ) |
ManualLogEntry::getDeleted | ( | ) |
ManualLogEntry::getIsPatrollable | ( | ) |
Whether this log entry is patrollable.
Definition at line 521 of file ManualLogEntry.php.
ManualLogEntry::getParameters | ( | ) |
ManualLogEntry::getPerformerIdentity | ( | ) |
ManualLogEntry::getRecentChange | ( | $newId = 0 | ) |
Get a RecentChanges object for the log entry.
int | $newId |
Definition at line 364 of file ManualLogEntry.php.
References getTimestamp(), and LogEntryBase\makeParamBlob().
ManualLogEntry::getSubtype | ( | ) |
ManualLogEntry::getTags | ( | ) |
ManualLogEntry::getTarget | ( | ) |
ManualLogEntry::getTimestamp | ( | ) |
Implements LogEntry.
Definition at line 486 of file ManualLogEntry.php.
References wfTimestamp(), and wfTimestampNow().
ManualLogEntry::getType | ( | ) |
ManualLogEntry::insert | ( | IDatabase | $dbw = null | ) |
Insert the entry into the logging
table.
IDatabase | null | $dbw |
MWException |
Definition at line 294 of file ManualLogEntry.php.
References getTimestamp(), LogEntryBase\makeParamBlob(), and wfTimestampNow().
ManualLogEntry::isLegacy | ( | ) |
Reimplemented from LogEntryBase.
Definition at line 529 of file ManualLogEntry.php.
ManualLogEntry::publish | ( | $newId, | |
$to = 'rcandudp' |
|||
) |
Publish the log entry.
int | $newId | Id of the log entry. |
string | $to | One of: rcandudp (default), rc, udp |
Definition at line 396 of file ManualLogEntry.php.
References ChangeTags\addTags(), DB_PRIMARY, and wfGetDB().
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.
int | $revId |
Definition at line 222 of file ManualLogEntry.php.
ManualLogEntry::setComment | ( | string | $comment | ) |
Set a comment associated with the action being logged.
string | $comment |
Definition at line 209 of file ManualLogEntry.php.
ManualLogEntry::setDeleted | ( | $deleted | ) |
Set the 'deleted' flag.
int | $deleted | One of LogPage::DELETED_* bitfield constants |
Definition at line 273 of file ManualLogEntry.php.
ManualLogEntry::setForceBotFlag | ( | bool | $forceBotFlag | ) |
Set the bot flag in the recent changes to this value.
bool | $forceBotFlag |
Definition at line 283 of file ManualLogEntry.php.
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
bool | $patrollable |
Definition at line 253 of file ManualLogEntry.php.
ManualLogEntry::setLegacy | ( | $legacy | ) |
Set the 'legacy' flag.
bool | $legacy |
Definition at line 263 of file ManualLogEntry.php.
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.
array | $parameters | Associative array |
Definition at line 149 of file ManualLogEntry.php.
ManualLogEntry::setPerformer | ( | UserIdentity | $performer | ) |
Set the user that performed the action being logged.
UserIdentity | $performer |
Definition at line 172 of file ManualLogEntry.php.
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.
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. |
Definition at line 162 of file ManualLogEntry.php.
ManualLogEntry::setTarget | ( | $target | ) |
Set the title of the object changed.
LinkTarget | PageReference | $target | calling with LinkTarget is deprecated since 1.37 |
Definition at line 183 of file ManualLogEntry.php.
ManualLogEntry::setTimestamp | ( | $timestamp | ) |
Set the timestamp of when the logged action took place.
string | $timestamp | Can be in any format accepted by ConvertibleTimestamp |
Definition at line 199 of file ManualLogEntry.php.
|
protected |
Comment for the log entry.
Definition at line 71 of file ManualLogEntry.php.
|
protected |
Deletion state of the log entry.
Definition at line 80 of file ManualLogEntry.php.
|
protected |
The bot flag in the recent changes will be set to this value.
Definition at line 92 of file ManualLogEntry.php.
|
protected |
ID of the log entry.
Definition at line 83 of file ManualLogEntry.php.
|
protected |
Can this log entry be patrolled?
Definition at line 86 of file ManualLogEntry.php.
|
protected |
Whether this is a legacy log entry.
Definition at line 89 of file ManualLogEntry.php.
|
protected |
Parameters for log entry.
Definition at line 56 of file ManualLogEntry.php.
|
protected |
Performer of the action for the log entry.
Definition at line 62 of file ManualLogEntry.php.
|
protected |
Definition at line 59 of file ManualLogEntry.php.
|
protected |
A rev id associated to the log entry.
Definition at line 74 of file ManualLogEntry.php.
|
protected |
Sub type of log entry.
Definition at line 53 of file ManualLogEntry.php.
|
protected |
Change tags add to the log entry.
Definition at line 77 of file ManualLogEntry.php.
|
protected |
Target title for the log entry.
Definition at line 65 of file ManualLogEntry.php.
|
protected |
Timestamp of creation of the log entry.
Definition at line 68 of file ManualLogEntry.php.
|
protected |
Type of log entry.
Definition at line 50 of file ManualLogEntry.php.