[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/logging/ -> LogEntry.php (summary)

Contain classes for dealing with individual log entries This is how I see the log system history: - appending to plain wiki pages - formatting log entries based on database fields - user is now part of the action message

Author: Niklas Laxström
License: http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
File Size: 646 lines (14 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 4 classes

LogEntry:: (13 methods):
  getType()
  getSubtype()
  getFullType()
  getParameters()
  getPerformer()
  getTarget()
  getTimestamp()
  getComment()
  getDeleted()
  isDeleted()
  getFullType()
  isDeleted()
  isLegacy()

DatabaseLogEntry:: (14 methods):
  getSelectQueryData()
  newFromRow()
  __construct()
  getId()
  getRawParameters()
  isLegacy()
  getType()
  getSubtype()
  getParameters()
  getPerformer()
  getTarget()
  getTimestamp()
  getComment()
  getDeleted()

RCDatabaseLogEntry:: (9 methods):
  getId()
  getRawParameters()
  getType()
  getSubtype()
  getPerformer()
  getTarget()
  getTimestamp()
  getComment()
  getDeleted()

ManualLogEntry:: (19 methods):
  __construct()
  setParameters()
  setRelations()
  setPerformer()
  setTarget()
  setTimestamp()
  setComment()
  setDeleted()
  insert()
  getRecentChange()
  publish()
  getType()
  getSubtype()
  getParameters()
  getPerformer()
  getTarget()
  getTimestamp()
  getComment()
  getDeleted()


Interface: LogEntry  - X-Ref

Interface for log entries. Every log entry has these methods.

getType()   X-Ref
The main log type.

return: string

getSubtype()   X-Ref
The log subtype.

return: string

getFullType()   X-Ref
The full logtype in format maintype/subtype.

return: string

getParameters()   X-Ref
Get the extra parameters stored for this message.

return: array

getPerformer()   X-Ref
Get the user for performed this action.

return: User

getTarget()   X-Ref
Get the target page of this action.

return: Title

getTimestamp()   X-Ref
Get the timestamp when the action was executed.

return: string

getComment()   X-Ref
Get the user provided comment.

return: string

getDeleted()   X-Ref
Get the access restriction.

return: string

isDeleted( $field )   X-Ref

param: int $field One of LogPage::DELETED_* bitfield constants
return: bool

getFullType()   X-Ref
Extends the LogEntryInterface with some basic functionality


isDeleted( $field )   X-Ref
No description

isLegacy()   X-Ref
Whether the parameters for this log are stored in new or
old format.

return: bool

Class: DatabaseLogEntry  - X-Ref

This class wraps around database result row.

getSelectQueryData()   X-Ref
Returns array of information that is needed for querying
log entries. Array contains the following keys:
tables, fields, conds, options and join_conds

return: array

newFromRow( $row )   X-Ref
Constructs new LogEntry from database result row.
Supports rows from both logging and recentchanges table.

param: stdClass|array $row
return: DatabaseLogEntry

__construct( $row )   X-Ref
No description

getId()   X-Ref
Returns the unique database id.

return: int

getRawParameters()   X-Ref
Returns whatever is stored in the database field.

return: string

isLegacy()   X-Ref
No description

getType()   X-Ref
No description

getSubtype()   X-Ref
No description

getParameters()   X-Ref
No description

getPerformer()   X-Ref
No description

getTarget()   X-Ref
No description

getTimestamp()   X-Ref
No description

getComment()   X-Ref
No description

getDeleted()   X-Ref
No description

Class: RCDatabaseLogEntry  - X-Ref

getId()   X-Ref
No description

getRawParameters()   X-Ref
No description

getType()   X-Ref
No description

getSubtype()   X-Ref
No description

getPerformer()   X-Ref
No description

getTarget()   X-Ref
No description

getTimestamp()   X-Ref
No description

getComment()   X-Ref
No description

getDeleted()   X-Ref
No description

Class: ManualLogEntry  - X-Ref

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

__construct( $type, $subtype )   X-Ref
Constructor.

param: string $type
param: string $subtype

setParameters( $parameters )   X-Ref
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'
);

param: array $parameters Associative array

setRelations( array $relations )   X-Ref
Declare arbitrary tag/value relations to this log entry.
These can be used to filter log entries later on.

param: array $relations Map of (tag => (list of values|value))

setPerformer( User $performer )   X-Ref
Set the user that performed the action being logged.

param: User $performer

setTarget( Title $target )   X-Ref
Set the title of the object changed.

param: Title $target

setTimestamp( $timestamp )   X-Ref
Set the timestamp of when the logged action took place.

param: string $timestamp

setComment( $comment )   X-Ref
Set a comment associated with the action being logged.

param: string $comment

setDeleted( $deleted )   X-Ref
TODO: document

param: int $deleted

insert( IDatabase $dbw = null )   X-Ref
Inserts the entry into the logging table.

param: IDatabase $dbw
return: int ID of the log entry

getRecentChange( $newId = 0 )   X-Ref
Get a RecentChanges object for the log entry

param: int $newId
return: RecentChange

publish( $newId, $to = 'rcandudp' )   X-Ref
Publishes the log entry.

param: int $newId Id of the log entry.
param: string $to One of: rcandudp (default), rc, udp

getType()   X-Ref
No description

getSubtype()   X-Ref
No description

getParameters()   X-Ref
No description

getPerformer()   X-Ref

return: User

getTarget()   X-Ref

return: Title

getTimestamp()   X-Ref
No description

getComment()   X-Ref
No description

getDeleted()   X-Ref
No description



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1