MediaWiki
master
|
Class for creating new log entries and inserting them into the database. More...
Public Member Functions | |
__construct ( $type, $subtype) | |
addTags ( $tags) | |
Add change tags for the log entry. More... | |
getAssociatedRevId () | |
getComment () | |
getDeleted () | |
getIsPatrollable () | |
Whether this log entry is patrollable. More... | |
getParameters () | |
getPerformerIdentity () | |
getRecentChange ( $newId=0) | |
Get a RecentChanges object for the log entry. More... | |
getSubtype () | |
getTags () | |
getTarget () | |
getTimestamp () | |
getType () | |
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 (string $comment) | |
Set a comment associated with the action being logged. More... | |
setDeleted ( $deleted) | |
Set the 'deleted' flag. More... | |
setForceBotFlag (bool $forceBotFlag) | |
Set the bot flag in the recent changes to this value. 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 (UserIdentity $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 ( $target) | |
Set the title of the object changed. More... | |
setTimestamp ( $timestamp) | |
Set the timestamp of when the logged action took place. More... | |
![]() | |
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... | |
bool null | $forceBotFlag = null |
The bot flag in the recent changes will be set to this value. 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... | |
UserIdentity | $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... | |
string[] | $tags = [] |
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 | extractParams ( $blob) |
Extract a parameter array from a blob. More... | |
static | makeParamBlob ( $params) |
Create a blob from a parameter array. More... | |
Class for creating new log entries and inserting them into the database.
Definition at line 47 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 101 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 237 of file ManualLogEntry.php.
References $tags.
Referenced by setTags().
ManualLogEntry::getAssociatedRevId | ( | ) |
ManualLogEntry::getComment | ( | ) |
ManualLogEntry::getDeleted | ( | ) |
ManualLogEntry::getIsPatrollable | ( | ) |
Whether this log entry is patrollable.
Definition at line 536 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 370 of file ManualLogEntry.php.
References getTimestamp(), SpecialPage\getTitleFor(), LogEntryBase\makeParamBlob(), RequestContext\newExtraneousContext(), LogFormatter\newFromEntry(), and RecentChange\newLogEntry().
ManualLogEntry::getSubtype | ( | ) |
ManualLogEntry::getTags | ( | ) |
ManualLogEntry::getTarget | ( | ) |
ManualLogEntry::getTimestamp | ( | ) |
Implements LogEntry.
Definition at line 501 of file ManualLogEntry.php.
References wfTimestamp(), and wfTimestampNow().
ManualLogEntry::getType | ( | ) |
Implements LogEntry.
Definition at line 466 of file ManualLogEntry.php.
References $type.
ManualLogEntry::insert | ( | IDatabase | $dbw = null | ) |
Insert the entry into the logging
table.
IDatabase | null | $dbw |
MWException |
Definition at line 299 of file ManualLogEntry.php.
References DB_PRIMARY, getTimestamp(), LogEntryBase\makeParamBlob(), wfGetDB(), and wfTimestampNow().
ManualLogEntry::isLegacy | ( | ) |
Reimplemented from LogEntryBase.
Definition at line 544 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 411 of file ManualLogEntry.php.
References DeferredUpdates\addCallableUpdate(), ChangeTags\addTags(), DB_PRIMARY, MediaWiki\Logger\LoggerFactory\getInstance(), 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 207 of file ManualLogEntry.php.
References $revId.
ManualLogEntry::setComment | ( | string | $comment | ) |
Set a comment associated with the action being logged.
string | $comment |
Definition at line 194 of file ManualLogEntry.php.
References $comment.
ManualLogEntry::setDeleted | ( | $deleted | ) |
Set the 'deleted' flag.
int | $deleted | One of LogPage::DELETED_* bitfield constants |
Definition at line 278 of file ManualLogEntry.php.
References $deleted.
ManualLogEntry::setForceBotFlag | ( | bool | $forceBotFlag | ) |
Set the bot flag in the recent changes to this value.
bool | $forceBotFlag |
Definition at line 288 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 258 of file ManualLogEntry.php.
ManualLogEntry::setLegacy | ( | $legacy | ) |
Set the 'legacy' flag.
bool | $legacy |
Definition at line 268 of file ManualLogEntry.php.
References $legacy.
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 (matching the $4 message parameter), 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).
Typically, these parameters will be used in the logentry-<type>-<subtype> message, but custom formatters, declared via $wgLogActionsHandlers, can override that.
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. Parameters which should be searchable need to be set with setRelations() instead.
Example: $entry->setParameters( '4::color' => 'blue', '5:number:count' => 3000, 'animal' => 'dog' );
array | $parameters | Associative array |
Definition at line 136 of file ManualLogEntry.php.
References $parameters.
ManualLogEntry::setPerformer | ( | UserIdentity | $performer | ) |
Set the user that performed the action being logged.
UserIdentity | $performer |
Definition at line 157 of file ManualLogEntry.php.
References $performer.
ManualLogEntry::setRelations | ( | array | $relations | ) |
Declare arbitrary tag/value relations to this log entry.
These can be used to filter log entries later on.
array | $relations | Map of (tag => (list of values|value)) |
Definition at line 147 of file ManualLogEntry.php.
References $relations.
ManualLogEntry::setTags | ( | $tags | ) |
Set change tags for the log entry.
Passing null
means the same as empty array, for compatibility with WikiPage::doUpdateRestrictions().
string | string[] | null | $tags |
Definition at line 222 of file ManualLogEntry.php.
References addTags(), wfDebug(), and wfDeprecated().
ManualLogEntry::setTarget | ( | $target | ) |
Set the title of the object changed.
LinkTarget | PageReference | $target | calling with LinkTarget is deprecated since 1.37 |
Definition at line 168 of file ManualLogEntry.php.
References $target.
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 184 of file ManualLogEntry.php.
References $timestamp.
|
protected |
Comment for the log entry.
Definition at line 70 of file ManualLogEntry.php.
Referenced by setComment().
|
protected |
Deletion state of the log entry.
Definition at line 79 of file ManualLogEntry.php.
Referenced by setDeleted().
|
protected |
The bot flag in the recent changes will be set to this value.
Definition at line 91 of file ManualLogEntry.php.
|
protected |
ID of the log entry.
Definition at line 82 of file ManualLogEntry.php.
|
protected |
Can this log entry be patrolled?
Definition at line 85 of file ManualLogEntry.php.
|
protected |
Whether this is a legacy log entry.
Definition at line 88 of file ManualLogEntry.php.
Referenced by setLegacy().
|
protected |
Parameters for log entry.
Definition at line 55 of file ManualLogEntry.php.
Referenced by setParameters().
|
protected |
Performer of the action for the log entry.
Definition at line 61 of file ManualLogEntry.php.
Referenced by setPerformer().
|
protected |
Definition at line 58 of file ManualLogEntry.php.
Referenced by setRelations().
|
protected |
A rev id associated to the log entry.
Definition at line 73 of file ManualLogEntry.php.
Referenced by setAssociatedRevId().
|
protected |
Sub type of log entry.
Definition at line 52 of file ManualLogEntry.php.
Referenced by __construct().
|
protected |
Change tags add to the log entry.
Definition at line 76 of file ManualLogEntry.php.
Referenced by addTags().
|
protected |
Target title for the log entry.
Definition at line 64 of file ManualLogEntry.php.
Referenced by setTarget().
|
protected |
Timestamp of creation of the log entry.
Definition at line 67 of file ManualLogEntry.php.
Referenced by setTimestamp().
|
protected |