/**
* Get the priority of a given namespace
*
- * @param int $namespace The namespace to get the priority for
- +
- * @return string
+ * @param $namespace Integer: the namespace to get the priority for
+ * @return String
*/
-
function priority( $namespace ) {
return isset( $this->priorities[$namespace] ) ? $this->priorities[$namespace] : $this->guessPriority( $namespace );
}
* default priority for the namespace, varies depending on whether it's
* a talkpage or not.
*
- * @param int $namespace The namespace to get the priority for
- *
- * @return string
+ * @param $namespace Integer: the namespace to get the priority for
+ * @return String
*/
function guessPriority( $namespace ) {
return MWNamespace::isMain( $namespace ) ? $this->priorities[GS_MAIN] : $this->priorities[GS_TALK];
/**
* Return a database resolution of all the pages in a given namespace
*
- * @param int $namespace Limit the query to this namespace
- *
- * @return resource
+ * @param $namespace Integer: limit the query to this namespace
+ * @return Resource
*/
function getPageRes( $namespace ) {
return $this->dbr->select( 'page',
/**
* Main loop
- *
- * @access public
*/
- function main() {
+ public function main() {
global $wgContLang;
fwrite( $this->findex, $this->openIndex() );
/**
* gzopen() / fopen() wrapper
*
- * @return resource
+ * @return Resource
*/
function open( $file, $flags ) {
return $this->compress ? gzopen( $file, $flags ) : fopen( $file, $flags );
/**
* Get a sitemap filename
*
- * @static
- *
- * @param int $namespace The namespace
- * @param int $count The count
- *
- * @return string
+ * @param $namespace Integer: the namespace
+ * @param $count Integer: the count
+ * @return String
*/
function sitemapFilename( $namespace, $count ) {
$ext = $this->compress ? '.gz' : '';
/**
* Return the XML required to open an XML file
*
- * @static
- *
* @return string
*/
function xmlHead() {
/**
* Return the XML schema being used
*
- * @static
- *
- * @returns string
+ * @return String
*/
function xmlSchema() {
return 'http://www.sitemaps.org/schemas/sitemap/0.9';
/**
* Return the XML required to open a sitemap index file
*
- * @return string
+ * @return String
*/
function openIndex() {
return $this->xmlHead() . '<sitemapindex xmlns="' . $this->xmlSchema() . '">' . "\n";
/**
* Return the XML for a single sitemap indexfile entry
*
- * @static
- *
- * @param string $filename The filename of the sitemap file
- *
- * @return string
+ * @param $filename String: the filename of the sitemap file
+ * @return String
*/
function indexEntry( $filename ) {
return
/**
* Return the XML required to close a sitemap index file
*
- * @static
- *
- * @return string
+ * @return String
*/
function closeIndex() {
return "</sitemapindex>\n";
/**
* Return the XML required to open a sitemap file
*
- * @return string
+ * @return String
*/
function openFile() {
return $this->xmlHead() . '<urlset xmlns="' . $this->xmlSchema() . '">' . "\n";
/**
* Return the XML for a single sitemap entry
*
- * @static
- *
- * @param string $url An RFC 2396 compliant URL
- * @param string $date A ISO 8601 date
- * @param string $priority A priority indicator, 0.0 - 1.0 inclusive with a 0.1 stepsize
- *
- * @return string
+ * @param $url String: an RFC 2396 compliant URL
+ * @param $date String: a ISO 8601 date
+ * @param $priority String: a priority indicator, 0.0 - 1.0 inclusive with a 0.1 stepsize
+ * @return String
*/
function fileEntry( $url, $date, $priority ) {
return
/**
* Return the XML required to close sitemap file
*
- * @static
- * @return string
+ * @return String
*/
function closeFile() {
return "</urlset>\n";