[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

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

Contain log classes Copyright © 2002, 2004 Brion Vibber <[email protected]> https://www.mediawiki.org/

File Size: 669 lines (18 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

LogPage:: (21 methods):
  __construct()
  saveContent()
  getRcComment()
  getRcCommentIRC()
  getComment()
  validTypes()
  isLogType()
  logName()
  logHeader()
  actionText()
  getTitleLink()
  addEntry()
  addRelations()
  makeParamBlob()
  extractParams()
  formatBlockFlags()
  formatBlockFlag()
  getName()
  getDescription()
  getRestriction()
  isRestricted()


Class: LogPage  - X-Ref

Class to simplify the use of log pages.
The logs are now kept in a table which is easier to manage and trim
than ever-growing wiki pages.

__construct( $type, $rc = true, $udp = 'skipUDP' )   X-Ref
Constructor

param: string $type One of '', 'block', 'protect', 'rights', 'delete',
param: bool $rc Whether to update recent changes as well as the logging table
param: string $udp Pass 'UDP' to send to the UDP feed if NOT sent to RC

saveContent()   X-Ref

return: int The log_id of the inserted log entry

getRcComment()   X-Ref
Get the RC comment from the last addEntry() call

return: string

getRcCommentIRC()   X-Ref
Get the RC comment from the last addEntry() call for IRC

return: string

getComment()   X-Ref
Get the comment from the last addEntry() call

return: string

validTypes()   X-Ref
Get the list of valid log types

return: array Array of strings

isLogType( $type )   X-Ref
Is $type a valid log type

param: string $type Log type to check
return: bool

logName( $type )   X-Ref
Get the name for the given log type

param: string $type Log type
return: string Log name

logHeader( $type )   X-Ref
Get the log header for the given log type

param: string $type Logtype
return: string Header text of this logtype

actionText( $type, $action, $title = null, $skin = null,$params = array()   X-Ref
Generate text for a log entry.
Only LogFormatter should call this function.

param: string $type Log type
param: string $action Log action
param: Title|null $title Title object or null
param: Skin|null $skin Skin object or null. If null, we want to use the wiki
param: array $params Parameters
param: bool $filterWikilinks Whether to filter wiki links
return: string HTML

getTitleLink( $type, $lang, $title, &$params )   X-Ref

param: string $type
param: Language|null $lang
param: Title $title
param: array $params
return: string

addEntry( $action, $target, $comment, $params = array()   X-Ref
Add a log entry

param: string $action One of '', 'block', 'protect', 'rights', 'delete',
param: Title $target Title object
param: string $comment Description associated
param: array $params Parameters passed later to wfMessage function
param: null|int|User $doer The user doing the action. null for $wgUser
return: int The log_id of the inserted log entry

addRelations( $field, $values, $logid )   X-Ref
Add relations to log_search table

param: string $field
param: array $values
param: int $logid
return: bool

makeParamBlob( $params )   X-Ref
Create a blob from a parameter array

param: array $params
return: string

extractParams( $blob )   X-Ref
Extract a parameter array from a blob

param: string $blob
return: array

formatBlockFlags( $flags, $lang )   X-Ref
Convert a comma-delimited list of block log flags
into a more readable (and translated) form

param: string $flags Flags to format
param: Language $lang
return: string

formatBlockFlag( $flag, $lang )   X-Ref
Translate a block log flag if possible

param: int $flag Flag to translate
param: Language $lang Language object to use
return: string

getName()   X-Ref
Name of the log.

return: Message

getDescription()   X-Ref
Description of this log type.

return: Message

getRestriction()   X-Ref
Returns the right needed to read this log type.

return: string

isRestricted()   X-Ref
Tells if this log is not viewable by all.

return: bool



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