MediaWiki REL1_30
|
Class for creating log entries manually, to inject them into the database. More...
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. | |
Class for creating log entries manually, to inject them into the database.
Definition at line 400 of file LogEntry.php.
ManualLogEntry::__construct | ( | $type, | |
$subtype | |||
) |
ManualLogEntry::getAssociatedRevId | ( | ) |
Definition at line 780 of file LogEntry.php.
References $revId.
Referenced by insert().
ManualLogEntry::getComment | ( | ) |
Get the user provided comment.
Implements LogEntry.
Definition at line 772 of file LogEntry.php.
References $comment.
Referenced by insert().
ManualLogEntry::getDeleted | ( | ) |
Get the access restriction.
Implements LogEntry.
Definition at line 810 of file LogEntry.php.
References $deleted.
ManualLogEntry::getIsPatrollable | ( | ) |
Whether this log entry is patrollable.
Definition at line 798 of file LogEntry.php.
References $isPatrollable.
Referenced by publish().
ManualLogEntry::getParameters | ( | ) |
Get the extra parameters stored for this message.
Implements LogEntry.
Definition at line 748 of file LogEntry.php.
References $parameters.
Referenced by insert().
ManualLogEntry::getPerformer | ( | ) |
Implements LogEntry.
Definition at line 755 of file LogEntry.php.
References $performer.
Referenced by getRecentChange(), insert(), and publish().
ManualLogEntry::getRecentChange | ( | $newId = 0 | ) |
Get a RecentChanges object for the log entry.
int | $newId |
Definition at line 666 of file LogEntry.php.
References $context, $user, getPerformer(), getTarget(), getTimestamp(), SpecialPage\getTitleFor(), getType(), LogEntryBase\makeParamBlob(), RequestContext\newExtraneousContext(), LogFormatter\newFromEntry(), and RecentChange\newLogEntry().
Referenced by publish().
ManualLogEntry::getSubtype | ( | ) |
The log subtype.
Implements LogEntry.
Definition at line 744 of file LogEntry.php.
References $subtype.
Referenced by insert().
ManualLogEntry::getTags | ( | ) |
Definition at line 788 of file LogEntry.php.
References $tags.
Referenced by publish().
ManualLogEntry::getTarget | ( | ) |
Implements LogEntry.
Definition at line 762 of file LogEntry.php.
References $target.
Referenced by getRecentChange(), and insert().
ManualLogEntry::getTimestamp | ( | ) |
Get the timestamp when the action was executed.
Implements LogEntry.
Definition at line 766 of file LogEntry.php.
References wfTimestamp(), and wfTimestampNow().
Referenced by getRecentChange(), and insert().
ManualLogEntry::getType | ( | ) |
The main log type.
Implements LogEntry.
Definition at line 740 of file LogEntry.php.
References $type.
Referenced by getRecentChange(), insert(), and publish().
ManualLogEntry::insert | ( | IDatabase | $dbw = null | ) |
Insert the entry into the logging
table.
IDatabase | $dbw |
MWException |
Definition at line 595 of file LogEntry.php.
References $comment, $deleted, $id, $params, $relations, $revId, $rows, $value, as, DB_MASTER, getAssociatedRevId(), getComment(), getParameters(), getPerformer(), getSubtype(), getTarget(), getTimestamp(), getType(), LogEntryBase\makeParamBlob(), CommentStore\newKey(), wfGetDB(), and wfTimestampNow().
ManualLogEntry::isLegacy | ( | ) |
Reimplemented from LogEntryBase.
Definition at line 806 of file LogEntry.php.
References $legacy.
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 706 of file LogEntry.php.
References $tags, DB_MASTER, getIsPatrollable(), getPerformer(), getRecentChange(), getTags(), getType(), PatrolLog\record(), use, 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 538 of file LogEntry.php.
References $revId.
ManualLogEntry::setComment | ( | $comment | ) |
Set a comment associated with the action being logged.
string | $comment |
Definition at line 525 of file LogEntry.php.
References $comment.
ManualLogEntry::setDeleted | ( | $deleted | ) |
Set the 'deleted' flag.
int | $deleted | One of LogPage::DELETED_* bitfield constants |
Definition at line 584 of file LogEntry.php.
References $deleted.
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 564 of file LogEntry.php.
ManualLogEntry::setLegacy | ( | $legacy | ) |
Set the 'legacy' flag.
bool | $legacy |
Definition at line 574 of file LogEntry.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, 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' );
array | $parameters | Associative array |
Definition at line 474 of file LogEntry.php.
References $parameters.
ManualLogEntry::setPerformer | ( | User | $performer | ) |
Set the user that performed the action being logged.
User | $performer |
Definition at line 495 of file LogEntry.php.
References $performer.
Referenced by EditPage\addContentModelChangeLogEntry(), and SpecialChangeContentModel\onSubmit().
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 485 of file LogEntry.php.
References $relations.
ManualLogEntry::setTags | ( | $tags | ) |
Set change tags for the log entry.
string | string[] | $tags |
Definition at line 548 of file LogEntry.php.
References $tags.
ManualLogEntry::setTarget | ( | Title | $target | ) |
Set the title of the object changed.
Title | $target |
Definition at line 505 of file LogEntry.php.
References $target.
ManualLogEntry::setTimestamp | ( | $timestamp | ) |
Set the timestamp of when the logged action took place.
string | $timestamp |
Definition at line 515 of file LogEntry.php.
References $timestamp.
Referenced by LocalFile\recordUpload2().
|
protected |
Comment for the log entry.
Definition at line 423 of file LogEntry.php.
Referenced by getComment(), insert(), and setComment().
|
protected |
Deletion state of the log entry.
Definition at line 432 of file LogEntry.php.
Referenced by getDeleted(), insert(), and setDeleted().
|
protected |
|
protected |
Can this log entry be patrolled?
Definition at line 438 of file LogEntry.php.
Referenced by getIsPatrollable().
|
protected |
Whether this is a legacy log entry.
Definition at line 441 of file LogEntry.php.
Referenced by isLegacy(), and setLegacy().
|
protected |
Parameters for log entry.
Definition at line 408 of file LogEntry.php.
Referenced by getParameters(), and setParameters().
|
protected |
Performer of the action for the log entry.
Definition at line 414 of file LogEntry.php.
Referenced by getPerformer(), and setPerformer().
|
protected |
Definition at line 411 of file LogEntry.php.
Referenced by insert(), and setRelations().
|
protected |
A rev id associated to the log entry.
Definition at line 426 of file LogEntry.php.
Referenced by getAssociatedRevId(), insert(), and setAssociatedRevId().
|
protected |
Sub type of log entry.
Definition at line 405 of file LogEntry.php.
Referenced by __construct(), and getSubtype().
|
protected |
Change tags add to the log entry.
Definition at line 429 of file LogEntry.php.
|
protected |
Target title for the log entry.
Definition at line 417 of file LogEntry.php.
Referenced by getTarget(), and setTarget().
|
protected |
Timestamp of creation of the log entry.
Definition at line 420 of file LogEntry.php.
Referenced by setTimestamp().
|
protected |
Type of log entry.
Definition at line 402 of file LogEntry.php.
Referenced by __construct(), and getType().