UnusedimagesPage Class Reference

A special page that lists unused images. More...

Inheritance diagram for UnusedimagesPage:

Collaboration diagram for UnusedimagesPage:

List of all members.

Public Member Functions
	__construct ($name= 'Unusedimages')
	getPageHeader ()
	The content returned by this function will be output before any result.
	getQueryInfo ()
	Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s) for passing to Database::select() fields => Field(s) for passing to Database::select(), may be * conds => WHERE conditions options => options join_conds => JOIN conditions.
	isExpensive ()
	Is this query expensive (for some definition of expensive)? Then we don't let it run in miser mode.
	isSyndicated ()
	Sometime we don't want to build rss / atom feeds.
	sortDescending ()
	Override to sort by increasing values.
	usesTimestamps ()
	Does this query return timestamps rather than integers in its 'value' field? If true, this class will convert 'value' to a UNIX timestamp for caching.
Protected Member Functions
	getGroupName ()
	Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

---

Detailed Description

A special page that lists unused images.

Definition at line 29 of file SpecialUnusedimages.php.

---

Constructor & Destructor Documentation

UnusedimagesPage::__construct

(

$

name = 'Unusedimages'

)

Definition at line 30 of file SpecialUnusedimages.php.

References $name.

---

Member Function Documentation

UnusedimagesPage::getGroupName

(

)

[protected]

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Returns:

string

Since:

1.21

Reimplemented from SpecialPage.

Definition at line 83 of file SpecialUnusedimages.php.

UnusedimagesPage::getPageHeader

(

)

The content returned by this function will be output before any result.

Returns:

string

Reimplemented from QueryPage.

Definition at line 79 of file SpecialUnusedimages.php.

References SpecialPage\msg().

UnusedimagesPage::getQueryInfo

(

)

Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s) for passing to Database::select() fields => Field(s) for passing to Database::select(), may be * conds => WHERE conditions options => options join_conds => JOIN conditions.

Note that the query itself should return the following three columns: 'namespace', 'title', and 'value'. 'value' is used for sorting.

These may be stored in the querycache table for expensive queries, and that cached data will be returned sometimes, so the presence of extra fields can't be relied upon. The cached 'value' column will be an integer; non-numeric values are useful only for sorting the initial query (except if they're timestamps, see usesTimestamps()).

Don't include an ORDER or LIMIT clause, they will be added.

If this function is not overridden or returns something other than an array, getSQL() will be used instead. This is for backwards compatibility only and is strongly deprecated.

Returns:

array

Since:

1.18

Reimplemented from QueryPage.

Definition at line 46 of file SpecialUnusedimages.php.

References $retval, array(), and global.

UnusedimagesPage::isExpensive

(

)

Is this query expensive (for some definition of expensive)? Then we don't let it run in miser mode.

$wgDisableQueryPages causes all query pages to be declared expensive. Some query pages are always expensive.

Returns:

bool

Reimplemented from QueryPage.

Definition at line 34 of file SpecialUnusedimages.php.

UnusedimagesPage::isSyndicated

(

)

Sometime we don't want to build rss / atom feeds.

Returns:

bool

Reimplemented from QueryPage.

Definition at line 42 of file SpecialUnusedimages.php.

UnusedimagesPage::sortDescending

(

)

Override to sort by increasing values.

Returns:

bool

Reimplemented from QueryPage.

Definition at line 38 of file SpecialUnusedimages.php.

UnusedimagesPage::usesTimestamps

(

)

Does this query return timestamps rather than integers in its 'value' field? If true, this class will convert 'value' to a UNIX timestamp for caching.

NOTE: formatRow() may get timestamps in TS_MW (mysql), TS_DB (pgsql) or TS_UNIX (querycache) format, so be sure to always run them through wfTimestamp()

Returns:

bool

Since:

1.18

Reimplemented from QueryPage.

Definition at line 75 of file SpecialUnusedimages.php.

---

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

• includes/specials/SpecialUnusedimages.php