Inheritance diagram for LogPager:

Collaboration diagram for LogPager:

Public Member Functions
	__construct ($list, $types=array(), $performer= '', $title= '', $pattern= '', $conds=array(), $year=false, $month=false, $tagFilter= '')
	Constructor.
	doQuery ()
	Do the query, using information from the object context.
	formatRow ($row)
	Abstract formatting function.
	getDefaultQuery ()
	Get an array of query parameters that should be put into self-links.
	getFilterParams ()
	getIndexField ()
	This function should be overridden to return the name of the index fi- eld.
	getMonth ()
	getPage ()
	getPattern ()
	getPerformer ()
	getQueryInfo ()
	Constructs the most part of the query.
	getStartBody ()
	Hook into getBody(), allows text to be inserted at the start.
	getTagFilter ()
	getType ()
	getYear ()
Public Attributes
LogEventsList	$mLogEventsList
	*
Protected Member Functions
	hasEqualsClause ($field)
	Checks if $this->mConds has $field matched to a single value.
Private Member Functions
	limitPerformer ($name)
	Set the log reader to return only entries by the given user.
	limitTitle ($page, $pattern)
	Set the log reader to return only entries affecting the given page.
	limitType ($types)
	Set the log reader to return only entries of the given type.
Private Attributes
string	$pattern = ''
	*
string	$performer = ''
	Events limited to those by performer when set *.
string Title	$title = ''
	Events limited to those about Title when set *.
string	$typeCGI = ''
	*
array	$types = array()
	Log types *.

Detailed Description

Definition at line 29 of file LogPager.php.

Constructor & Destructor Documentation

LogPager::__construct	(	$	list,
		$	types = `array()`,
		$	performer = `''`,
		$	title = `''`,
		$	pattern = `''`,
		$	conds = `array()`,
		$	year = `false`,
		$	month = `false`,
		$	tagFilter = `''`
	)

Constructor.

Parameters:

LogEventsList	$list
string \| array	$types	Log types to show
string	$performer	The user who made the log entries
string \| Title	$title	The page title the log entries are for
string	$pattern	Do a prefix search rather than an exact title match
array	$conds	Extra conditions for the query
int \| bool	$year	The year to start from. Default: false
int \| bool	$month	The month to start from. Default: false
string	$tagFilter	Tag

Definition at line 55 of file LogPager.php.

Member Function Documentation

LogPager::doQuery ( )

Do the query, using information from the object context.

This function has been kept minimal to make it overridable if necessary, to allow for result sets formed from multiple DB queries.

Reimplemented from IndexPager.

Definition at line 379 of file LogPager.php.

LogPager::formatRow ( $ row )

Abstract formatting function.

This should return an HTML string representing the result row $row. Rows will be concatenated and returned by getBody()

Parameters:

array | stdClass $row Database row

Returns:: string

Reimplemented from IndexPager.

Definition at line 341 of file LogPager.php.

LogPager::getDefaultQuery ( )

Get an array of query parameters that should be put into self-links.

By default, all parameters passed in the URL are used, except for a short blacklist.

Returns:: array Associative array

Reimplemented from IndexPager.

Definition at line 71 of file LogPager.php.

LogPager::getFilterParams ( )

Definition at line 82 of file LogPager.php.

LogPager::getIndexField ( )

This function should be overridden to return the name of the index fi- eld.

If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &count=querykey will use indexfield to sort. In this case, the first returned key is the default.

Needless to say, it's really not a good idea to use a non-unique index for this! That won't page right.

Returns:: string|array

Reimplemented from IndexPager.

Definition at line 315 of file LogPager.php.

LogPager::getMonth ( )

Definition at line 371 of file LogPager.php.

LogPager::getPage ( )

Returns:: string

Definition at line 359 of file LogPager.php.

LogPager::getPattern ( )

Definition at line 363 of file LogPager.php.

LogPager::getPerformer ( )

Returns:: string

Definition at line 352 of file LogPager.php.

LogPager::getQueryInfo ( )

Constructs the most part of the query.

Extra conditions are sprinkled in all over this class.

Returns:: array

Reimplemented from IndexPager.

Definition at line 257 of file LogPager.php.

References $conds, $options, $tables, array(), DatabaseLogEntry\getSelectQueryData(), hasEqualsClause(), and ChangeTags\modifyDisplayQuery().

LogPager::getStartBody ( )

Hook into getBody(), allows text to be inserted at the start.

This will be called even if there are no rows in the result set.

Returns:: string

Reimplemented from IndexPager.

Definition at line 319 of file LogPager.php.

LogPager::getTagFilter ( )

Definition at line 375 of file LogPager.php.

LogPager::getType ( )

Definition at line 345 of file LogPager.php.

LogPager::getYear ( )

Definition at line 367 of file LogPager.php.

LogPager::hasEqualsClause ( $ field ) [protected]

Checks if $this->mConds has $field matched to a *single* value.

Parameters:

string $field

Returns:: bool

Definition at line 308 of file LogPager.php.

Referenced by getQueryInfo().

LogPager::limitPerformer ( $ name ) [private]

Set the log reader to return only entries by the given user.

Parameters:

string $name (In)valid user name

Returns:: void

Definition at line 153 of file LogPager.php.

LogPager::limitTitle	(	$	page,
		$	pattern
	)		`[private]`

Set the log reader to return only entries affecting the given page.

(For the block and rights logs, this is a user page.)

Parameters:

string \| Title	$page	Title name
string	$pattern

Returns:: void

Definition at line 188 of file LogPager.php.

LogPager::limitType ( $ types ) [private]

Set the log reader to return only entries of the given type.

Type restrictions enforced here

Parameters:

string | array $types Log types ('upload', 'delete', etc); empty string means no restriction

Definition at line 109 of file LogPager.php.

Member Data Documentation

LogEventsList LogPager::$mLogEventsList

*

Definition at line 40 of file LogPager.php.

string LogPager::$pattern = '' [private]

*

Definition at line 36 of file LogPager.php.

string LogPager::$performer = '' [private]

Events limited to those by performer when set *.

Definition at line 32 of file LogPager.php.

string Title LogPager::$title = '' [private]

Events limited to those about Title when set *.

Definition at line 34 of file LogPager.php.

string LogPager::$typeCGI = '' [private]

*

Definition at line 38 of file LogPager.php.

array LogPager::$types = array() [private]

Log types *.

Definition at line 30 of file LogPager.php.

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

includes/logging/LogPager.php

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation