MediaWiki  REL1_19
Public Member Functions | Protected Attributes
ManualLogEntry Class Reference

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

Inheritance diagram for ManualLogEntry:
Inheritance graph
[legend]
Collaboration diagram for ManualLogEntry:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ($type, $subtype)
 Constructor.
 getComment ()
 Get the user provided comment.
 getDeleted ()
 Get the access restriction.
 getParameters ()
 Get the extra parameters stored for this message.
 getPerformer ()
 Get the user for performed this action.
 getSubtype ()
 The log subtype.
 getTarget ()
 Get the target page of this action.
 getTimestamp ()
 Get the timestamp when the action was executed.
 getType ()
 The main log type.
 insert ()
 Inserts the entry into the logging table.
 publish ($newId, $to= 'rcandudp')
 Publishes the log entry.
 setComment ($comment)
 Set a comment associated with the action being logged.
 setDeleted ($deleted)
 TODO: document.
 setParameters ($parameters)
 Set extra log parameters.
 setPerformer (User $performer)
 Set the user that performed the action being logged.
 setTarget (Title $target)
 Set the title of the object changed.
 setTimestamp ($timestamp)
 Set the timestamp of when the logged action took place.

Protected Attributes

 $comment = ''
 $deleted
 $parameters = array()
 $performer
 $subtype
 $target
 $timestamp
 $type

Detailed Description

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

Since:
1.19

Definition at line 310 of file LogEntry.php.

Constructor & Destructor Documentation

ManualLogEntry::__construct ( $  type,
$  subtype 
)

Constructor.

Since:
1.19
Parameters:
string$type
string$subtype

Definition at line 328 of file LogEntry.php.

References $subtype, and $type.

Member Function Documentation

ManualLogEntry::getComment ( )

Get the user provided comment.

Returns:
string

Implements LogEntry.

Definition at line 510 of file LogEntry.php.

Referenced by insert(), and publish().

Here is the caller graph for this function:

ManualLogEntry::getDeleted ( )

Get the access restriction.

Returns:
string

Implements LogEntry.

Definition at line 514 of file LogEntry.php.

ManualLogEntry::getParameters ( )

Get the extra parameters stored for this message.

Returns:
array

Implements LogEntry.

Definition at line 493 of file LogEntry.php.

Referenced by insert(), and publish().

Here is the caller graph for this function:

ManualLogEntry::getPerformer ( )

Get the user for performed this action.

Returns:
User

Implements LogEntry.

Definition at line 497 of file LogEntry.php.

Referenced by insert(), and publish().

Here is the caller graph for this function:

ManualLogEntry::getSubtype ( )

The log subtype.

Returns:
string

Implements LogEntry.

Definition at line 489 of file LogEntry.php.

Referenced by insert(), and publish().

Here is the caller graph for this function:

ManualLogEntry::getTarget ( )

Get the target page of this action.

Returns:
Title

Implements LogEntry.

Definition at line 501 of file LogEntry.php.

Referenced by insert(), and publish().

Here is the caller graph for this function:

ManualLogEntry::getTimestamp ( )

Get the timestamp when the action was executed.

Returns:
string

Implements LogEntry.

Definition at line 505 of file LogEntry.php.

References wfTimestamp(), and wfTimestampNow().

Referenced by publish().

Here is the call graph for this function:

Here is the caller graph for this function:

ManualLogEntry::getType ( )

The main log type.

Returns:
string

Implements LogEntry.

Definition at line 485 of file LogEntry.php.

Referenced by insert(), and publish().

Here is the caller graph for this function:

ManualLogEntry::insert ( )

Inserts the entry into the logging table.

Returns:
int If of the log entry

Definition at line 412 of file LogEntry.php.

References $comment, $wgContLang, getComment(), getParameters(), getPerformer(), getSubtype(), getTarget(), getType(), wfGetDB(), and wfTimestampNow().

Here is the call graph for this function:

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

Publishes the log entry.

Parameters:
$newIdint id of the log entry.
$tostring: rcandudp (default), rc, udp

Definition at line 448 of file LogEntry.php.

References $user, getComment(), getParameters(), getPerformer(), getSubtype(), getTarget(), getTimestamp(), SpecialPage\getTitleFor(), getType(), RequestContext\newExtraneousContext(), LogFormatter\newFromEntry(), and RecentChange\newLogEntry().

Here is the call graph for this function:

ManualLogEntry::setComment ( $  comment)

Set a comment associated with the action being logged.

Since:
1.19
Parameters:
string$comment

Definition at line 393 of file LogEntry.php.

References $comment.

ManualLogEntry::setDeleted ( $  deleted)

TODO: document.

Since:
1.19
Parameters:
integer$deleted

Definition at line 404 of file LogEntry.php.

References $deleted.

ManualLogEntry::setParameters ( $  parameters)

Set extra log parameters.

You can pass params to the log action message by prefixing the keys with a number and colon. The numbering should start with number 4, the first three parameters are hardcoded for every message. Example: $entry->setParameters( '4:color' => 'blue', 'animal' => 'dog' );

Since:
1.19
Parameters:
$parametersAssociative array

Definition at line 349 of file LogEntry.php.

References $parameters.

ManualLogEntry::setPerformer ( User $  performer)

Set the user that performed the action being logged.

Since:
1.19
Parameters:
User$performer

Definition at line 360 of file LogEntry.php.

References $performer.

ManualLogEntry::setTarget ( Title $  target)

Set the title of the object changed.

Since:
1.19
Parameters:
Title$target

Definition at line 371 of file LogEntry.php.

References $target.

ManualLogEntry::setTimestamp ( $  timestamp)

Set the timestamp of when the logged action took place.

Since:
1.19
Parameters:
string$timestamp

Definition at line 382 of file LogEntry.php.

References $timestamp.

Member Data Documentation

ManualLogEntry::$comment = '' [protected]

Definition at line 317 of file LogEntry.php.

Referenced by insert(), and setComment().

ManualLogEntry::$deleted [protected]

Definition at line 318 of file LogEntry.php.

Referenced by setDeleted().

ManualLogEntry::$parameters = array() [protected]

Definition at line 313 of file LogEntry.php.

Referenced by setParameters().

ManualLogEntry::$performer [protected]

Definition at line 314 of file LogEntry.php.

Referenced by setPerformer().

ManualLogEntry::$subtype [protected]

Definition at line 312 of file LogEntry.php.

Referenced by __construct().

ManualLogEntry::$target [protected]

Definition at line 315 of file LogEntry.php.

Referenced by setTarget().

ManualLogEntry::$timestamp [protected]

Definition at line 316 of file LogEntry.php.

Referenced by setTimestamp().

ManualLogEntry::$type [protected]

Definition at line 311 of file LogEntry.php.

Referenced by __construct().

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