<?php
-
-require_once ( "Feed.php" );
-
-# This is a class for doing query pages; since they're almost all the same,
-# we factor out some of the functionality into a superclass, and let
-# subclasses derive from it.
-
+/**
+ * Contain a class for special pages
+ * @package MediaWiki
+ */
+
+/**
+ *
+ */
+require_once ( 'Feed.php' );
+
+/**
+ * This is a class for doing query pages; since they're almost all the same,
+ * we factor out some of the functionality into a superclass, and let
+ * subclasses derive from it.
+ *
+ * @package MediaWiki
+ */
class QueryPage {
- # Subclasses return their name here. Make sure the name is also
- # specified in SpecialPage.php and in Language.php as a language message param.
+ /**
+ * Subclasses return their name here. Make sure the name is also
+ * specified in SpecialPage.php and in Language.php as a language message
+ * param.
+ */
function getName() {
- return "";
+ return '';
}
- # Subclasses return an SQL query here.
- #
- # Note that the query itself should return the following four columns:
- # 'type' (your special page's name), 'namespace', 'title', and 'value'
- # *in that order*. '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.
- #
- # Don't include an ORDER or LIMIT clause, this will be added.
-
+ /**
+ * Subclasses return an SQL query here.
+ *
+ * Note that the query itself should return the following four columns:
+ * 'type' (your special page's name), 'namespace', 'title', and 'value'
+ * *in that order*. '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.
+ *
+ * Don't include an ORDER or LIMIT clause, this will be added.
+ */
function getSQL() {
return "SELECT 'sample' as type, 0 as namespace, 'Sample result' as title, 42 as value";
}
- # Override to sort by increasing values
+ /**
+ * Override to sort by increasing values
+ */
function sortDescending() {
return true;
}
- # Don't override this unless you're darn sure.
- function getOrderLimit( $offset, $limit ) {
- return " ORDER BY value " .
- ($this->sortDescending() ? "DESC" : "")
- . wfLimitResult($limit,$offset);
- }
-
function getOrder() {
- return " ORDER BY value " .
- ($this->sortDescending() ? "DESC" : "");
+ return ' ORDER BY value ' .
+ ($this->sortDescending() ? 'DESC' : '');
}
- # 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.
+ /**
+ * 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.
+ */
function isExpensive( ) {
global $wgDisableQueryPages;
return $wgDisableQueryPages;
}
- # Formats the results of the query for display. The skin is the current
- # skin; you can use it for making links. The result is a single row of
- # result data. You should be able to grab SQL results off of it.
-
+ /**
+ * Formats the results of the query for display. The skin is the current
+ * skin; you can use it for making links. The result is a single row of
+ * result data. You should be able to grab SQL results off of it.
+ */
function formatResult( $skin, $result ) {
- return "";
+ return '';
}
- # This is the actual workhorse. It does everything needed to make a
- # real, honest-to-gosh query page.
+ /**
+ * The content returned by this function will be output before any result
+ */
+ function getPageHeader( ) {
+ return '';
+ }
+ /**
+ * This is the actual workhorse. It does everything needed to make a
+ * real, honest-to-gosh query page.
+ *
+ * @param $offset database query offset
+ * @param $limit database query limit
+ */
function doQuery( $offset, $limit ) {
global $wgUser, $wgOut, $wgLang, $wgRequest;
global $wgMiserMode;
$sname = $this->getName();
- $fname = get_class($this) . "::doQuery";
+ $fname = get_class($this) . '::doQuery';
$sql = $this->getSQL();
$dbr =& wfGetDB( DB_SLAVE );
$dbw =& wfGetDB( DB_MASTER );
$res = false;
if ( $this->isExpensive() ) {
- $recache = $wgRequest->getBool( "recache" );
+ $recache = $wgRequest->getBool( 'recache' );
if( $recache ) {
# Clear out any old cached data
$dbw->delete( 'querycache', array( 'qc_type' => $sname ), $fname );
if ( $first ) {
$first = false;
} else {
- $insertSql .= ",";
+ $insertSql .= ',';
}
- $insertSql .= "(" .
- $dbw->addQuotes( $row->type ) . "," .
- $dbw->addQuotes( $row->namespace ) . "," .
- $dbw->addQuotes( $row->title ) . "," .
- $dbw->addQuotes( $row->value ) . ")";
+ $insertSql .= '(' .
+ $dbw->addQuotes( $row->type ) . ',' .
+ $dbw->addQuotes( $row->namespace ) . ',' .
+ $dbw->addQuotes( $row->title ) . ',' .
+ $dbw->addQuotes( $row->value ) . ')';
}
# Save results into the querycache table on the master
FROM $querycache WHERE qc_type='$type'";
}
if( $wgMiserMode ) {
- $wgOut->addWikiText( wfMsg( "perfcached" ) );
+ $wgOut->addWikiText( wfMsg( 'perfcached' ) );
}
}
if ( $res === false ) {
- $res = $dbr->query( $sql . $this->getOrder() .
+ $res = $dbr->query( $sql . $this->getOrder() .
$dbr->limitResult( $limit,$offset ), $fname );
$num = $dbr->numRows($res);
}
$sk = $wgUser->getSkin( );
+ $wgOut->addHTML( $this->getPageHeader() );
+
$top = wfShowingResults( $offset, $num);
$wgOut->addHTML( "<p>{$top}\n" );
# Only read at most $num rows, because $res may contain the whole 1000
for ( $i = 0; $i < $num && $obj = $dbr->fetchObject( $res ); $i++ ) {
$format = $this->formatResult( $sk, $obj );
- $attr = ( !is_null ( $obj->usepatrol ) && $obj->usepatrol &&
+ $attr = ( isset ( $obj->usepatrol ) && $obj->usepatrol &&
$obj->patrolled == 0 ) ? ' class="not_patrolled"' : '';
$s .= "<li{$attr}>{$format}</li>\n";
}
$dbr->freeResult( $res );
- $s .= "</ol>";
+ $s .= '</ol>';
$wgOut->addHTML( $s );
$wgOut->addHTML( "<p>{$sl}</p>\n" );
}
- # Similar to above, but packaging in a syndicated feed instead of a web page
- function doFeed( $class = "" ) {
+ /**
+ * Similar to above, but packaging in a syndicated feed instead of a web page
+ */
+ function doFeed( $class = '' ) {
global $wgFeedClasses;
global $wgOut, $wgLanguageCode, $wgLang;
if( isset($wgFeedClasses[$class]) ) {
$dbr =& wfGetDB( DB_SLAVE );
$sql = $this->getSQL() . $this->getOrder().$dbr->limitResult( 50, 0 );
- $res = $dbr->query( $sql, "QueryPage::doFeed" );
+ $res = $dbr->query( $sql, 'QueryPage::doFeed' );
while( $obj = $dbr->fetchObject( $res ) ) {
$item = $this->feedResult( $obj );
if( $item ) $feed->outItem( $item );
}
}
- # Override for custom handling. If the titles/links are ok, just do feedItemDesc()
+ /**
+ * Override for custom handling. If the titles/links are ok, just do
+ * feedItemDesc()
+ */
function feedResult( $row ) {
if( !isset( $row->title ) ) {
return NULL;
if( isset( $row->timestamp ) ) {
$date = $row->timestamp;
} else {
- $date = "";
+ $date = '';
}
- $comments = "";
+ $comments = '';
if( $title ) {
$talkpage = $title->getTalkPage();
$comments = $talkpage->getFullURL();
}
function feedItemDesc( $row ) {
- $text = "";
+ $text = '';
if( isset( $row->comment ) ) {
$text = htmlspecialchars( $row->comment );
} else {
- $text = "";
+ $text = '';
}
if( isset( $row->text ) ) {
- $text =
"<p>" . htmlspecialchars( wfMsg( "summary" ) ) . ": " . $text . "</p>\n<hr />\n<div>" .
+ $text =
'<p>' . htmlspecialchars( wfMsg( 'summary' ) ) . ': ' . $text . "</p>\n<hr />\n<div>" .
nl2br( htmlspecialchars( $row->text ) ) . "</div>";;
}
return $text;
if( isset( $row->user_text ) ) {
return $row->user_text;
} else {
- return "";
+ return '';
}
}
}
function feedDesc() {
- return wfMsg( "fromwikipedia" );
+ return wfMsg( 'tagline' );
}
function feedUrl() {
}
}
-# This is a subclass for very simple queries that are just looking for page
-# titles that match some criteria. It formats each result item as a link to
-# that page.
-
+/**
+ * This is a subclass for very simple queries that are just looking for page
+ * titles that match some criteria. It formats each result item as a link to
+ * that page.
+ *
+ * @package MediaWiki
+ */
class PageQueryPage extends QueryPage {
function formatResult( $skin, $result ) {
$nt = Title::makeTitle( $result->namespace, $result->title );
- return $skin->makeKnownLinkObj( $nt, "" );
+ return $skin->makeKnownLinkObj( $nt, '' );
}
}
dépôts / lhc / web / wiklou.git / blobdiff