Two new parser tests related to bug 6200
[lhc/web/wiklou.git] / maintenance / generateSitemap.php
index 8ca7934..9f356b9 100644 (file)
@@ -31,7 +31,7 @@ define( 'GS_TALK', -1 );
  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
  */
 
-require_once( dirname(__FILE__) . '/Maintenance.php' );
+require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
 class GenerateSitemap extends Maintenance {
        /**
@@ -141,7 +141,6 @@ class GenerateSitemap extends Maintenance {
         * Execute
         */
        public function execute() {
-               global $wgScriptPath;
                $this->setNamespacePriorities();
                $this->url_limit = 50000;
                $this->size_limit = pow( 2, 20 ) * 10;
@@ -182,15 +181,15 @@ class GenerateSitemap extends Maintenance {
         * Create directory if it does not exist and return pathname with a trailing slash
         */
        private static function init_path( $fspath ) {
-               if( !isset( $fspath ) ) {
+               if ( !isset( $fspath ) ) {
                        return null;
                }
                # Create directory if needed
-               if( $fspath && !is_dir( $fspath ) ) {
-                       wfMkdirParents( $fspath ) or die("Can not create directory $fspath.\n");
+               if ( $fspath && !is_dir( $fspath ) ) {
+                       wfMkdirParents( $fspath ) or die( "Can not create directory $fspath.\n" );
                }
 
-               return realpath( $fspath ). DIRECTORY_SEPARATOR ;
+               return realpath( $fspath ) . DIRECTORY_SEPARATOR ;
        }
 
        /**
@@ -199,7 +198,7 @@ class GenerateSitemap extends Maintenance {
        function generateNamespaces() {
                // Only generate for specific namespaces if $wgSitemapNamespaces is an array.
                global $wgSitemapNamespaces;
-               if( is_array( $wgSitemapNamespaces ) ) {
+               if ( is_array( $wgSitemapNamespaces ) ) {
                        $this->namespaces = $wgSitemapNamespaces;
                        return;
                }
@@ -221,11 +220,9 @@ class GenerateSitemap extends Maintenance {
        /**
         * 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 );
        }
@@ -235,9 +232,8 @@ class GenerateSitemap extends Maintenance {
         * 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];
@@ -246,9 +242,8 @@ class GenerateSitemap extends Maintenance {
        /**
         * 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',
@@ -264,10 +259,8 @@ class GenerateSitemap extends Maintenance {
 
        /**
         * Main loop
-        *
-        * @access public
         */
-       function main() {
+       public function main() {
                global $wgContLang;
 
                fwrite( $this->findex, $this->openIndex() );
@@ -301,11 +294,11 @@ class GenerateSitemap extends Maintenance {
                                $length += strlen( $entry );
                                $this->write( $this->file, $entry );
                                // generate pages for language variants
-                               if($wgContLang->hasVariants()){
+                               if ( $wgContLang->hasVariants() ) {
                                        $variants = $wgContLang->getVariants();
-                                       foreach($variants as $vCode){
-                                               if($vCode==$wgContLang->getCode()) continue; // we don't want default variant
-                                               $entry = $this->fileEntry( $title->getFullURL('',$vCode), $date, $this->priority( $namespace ) );
+                                       foreach ( $variants as $vCode ) {
+                                               if ( $vCode == $wgContLang->getCode() ) continue; // we don't want default variant
+                                               $entry = $this->fileEntry( $title->getFullURL( '', $vCode ), $date, $this->priority( $namespace ) );
                                                $length += strlen( $entry );
                                                $this->write( $this->file, $entry );
                                        }
@@ -323,7 +316,7 @@ class GenerateSitemap extends Maintenance {
        /**
         * gzopen() / fopen() wrapper
         *
-        * @return resource
+        * @return Resource
         */
        function open( $file, $flags ) {
                return $this->compress ? gzopen( $file, $flags ) : fopen( $file, $flags );
@@ -352,23 +345,18 @@ class GenerateSitemap extends Maintenance {
        /**
         * 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 "sitemap-".wfWikiID()."-NS_$namespace-$count.xml$ext";
+               return "sitemap-" . wfWikiID() . "-NS_$namespace-$count.xml$ext";
        }
 
        /**
         * Return the XML required to open an XML file
         *
-        * @static
-        *
         * @return string
         */
        function xmlHead() {
@@ -378,9 +366,7 @@ class GenerateSitemap extends Maintenance {
        /**
         * Return the XML schema being used
         *
-        * @static
-        *
-        * @returns string
+        * @return String
         */
        function xmlSchema() {
                return 'http://www.sitemaps.org/schemas/sitemap/0.9';
@@ -389,7 +375,7 @@ class GenerateSitemap extends Maintenance {
        /**
         * Return the XML required to open a sitemap index file
         *
-        * @return string
+        * @return String
         */
        function openIndex() {
                return $this->xmlHead() . '<sitemapindex xmlns="' . $this->xmlSchema() . '">' . "\n";
@@ -398,11 +384,8 @@ class GenerateSitemap extends Maintenance {
        /**
         * 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
@@ -415,9 +398,7 @@ class GenerateSitemap extends Maintenance {
        /**
         * Return the XML required to close a sitemap index file
         *
-        * @static
-        *
-        * @return string
+        * @return String
         */
        function closeIndex() {
                return "</sitemapindex>\n";
@@ -426,7 +407,7 @@ class GenerateSitemap extends Maintenance {
        /**
         * Return the XML required to open a sitemap file
         *
-        * @return string
+        * @return String
         */
        function openFile() {
                return $this->xmlHead() . '<urlset xmlns="' . $this->xmlSchema() . '">' . "\n";
@@ -435,13 +416,10 @@ class GenerateSitemap extends Maintenance {
        /**
         * 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
@@ -455,8 +433,7 @@ class GenerateSitemap extends Maintenance {
        /**
         * Return the XML required to close sitemap file
         *
-        * @static
-        * @return string
+        * @return String
         */
        function closeFile() {
                return "</urlset>\n";