MediaWiki  REL1_20
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 ()
 getSubtype ()
 The log subtype.
 getTarget ()
 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 326 of file LogEntry.php.

Constructor & Destructor Documentation

ManualLogEntry::__construct ( $  type,
$  subtype 
)

Constructor.

Since:
1.19
Parameters:
string$type
string$subtype

Definition at line 344 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 543 of file LogEntry.php.

Referenced by insert(), and publish().

ManualLogEntry::getDeleted ( )

Get the access restriction.

Returns:
string

Implements LogEntry.

Definition at line 547 of file LogEntry.php.

ManualLogEntry::getParameters ( )

Get the extra parameters stored for this message.

Returns:
array

Implements LogEntry.

Definition at line 520 of file LogEntry.php.

Referenced by insert(), and publish().

ManualLogEntry::getPerformer ( )
Returns:
User

Implements LogEntry.

Definition at line 527 of file LogEntry.php.

Referenced by insert(), and publish().

ManualLogEntry::getSubtype ( )

The log subtype.

Returns:
string

Implements LogEntry.

Definition at line 516 of file LogEntry.php.

Referenced by insert(), and publish().

ManualLogEntry::getTarget ( )
Returns:
Title

Implements LogEntry.

Definition at line 534 of file LogEntry.php.

Referenced by insert(), and publish().

ManualLogEntry::getTimestamp ( )

Get the timestamp when the action was executed.

Returns:
string

Implements LogEntry.

Definition at line 538 of file LogEntry.php.

References wfTimestamp(), and wfTimestampNow().

Referenced by publish().

ManualLogEntry::getType ( )

The main log type.

Returns:
string

Implements LogEntry.

Definition at line 512 of file LogEntry.php.

Referenced by insert(), and publish().

ManualLogEntry::insert ( )

Inserts the entry into the logging table.

Returns:
int If of the log entry

Definition at line 428 of file LogEntry.php.

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

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

Publishes the log entry.

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

Definition at line 464 of file LogEntry.php.

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

ManualLogEntry::setComment ( $  comment)

Set a comment associated with the action being logged.

Since:
1.19
Parameters:
string$comment

Definition at line 409 of file LogEntry.php.

References $comment.

ManualLogEntry::setDeleted ( $  deleted)

TODO: document.

Since:
1.19
Parameters:
integer$deleted

Definition at line 420 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:
$parametersarray Associative array

Definition at line 365 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 376 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 387 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 398 of file LogEntry.php.

References $timestamp.

Member Data Documentation

ManualLogEntry::$comment = '' [protected]

Definition at line 333 of file LogEntry.php.

Referenced by insert(), and setComment().

ManualLogEntry::$deleted [protected]

Definition at line 334 of file LogEntry.php.

Referenced by setDeleted().

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

Definition at line 329 of file LogEntry.php.

Referenced by setParameters().

ManualLogEntry::$performer [protected]

Definition at line 330 of file LogEntry.php.

Referenced by setPerformer().

ManualLogEntry::$subtype [protected]

Definition at line 328 of file LogEntry.php.

Referenced by __construct().

ManualLogEntry::$target [protected]

Definition at line 331 of file LogEntry.php.

Referenced by setTarget().

ManualLogEntry::$timestamp [protected]

Definition at line 332 of file LogEntry.php.

Referenced by setTimestamp().

ManualLogEntry::$type [protected]

Definition at line 327 of file LogEntry.php.

Referenced by __construct().

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