includes/api/ApiImportReporter.php

   1 <?php
   2 /**
   3  * Copyright © 2009 Roan Kattouw <roan.kattouw@gmail.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 namespace MediaWiki\Api;
  24
  25 use ImportReporter;
  26 use MediaWiki\MediaWikiServices;
  27 use MediaWiki\Page\PageIdentity;
  28 use MediaWiki\Title\ForeignTitle;
  29
  30 /**
  31  * Import reporter for the API
  32  * @ingroup API
  33  */
  34 class ApiImportReporter extends ImportReporter {
  35         /** @var array[] */
  36         private $mResultArr = [];
  37
  38         /**
  39          * @param ?PageIdentity $pageIdentity
  40          * @param ForeignTitle $foreignTitle
  41          * @param int $revisionCount
  42          * @param int $successCount
  43          * @param array $pageInfo
  44          * @return void
  45          */
  46         public function reportPage( ?PageIdentity $pageIdentity, $foreignTitle, $revisionCount, $successCount, $pageInfo ) {
  47                 // Add a result entry
  48                 $r = [];
  49
  50                 if ( $pageIdentity === null ) {
  51                         # Invalid or non-importable title
  52                         $r['title'] = $pageInfo['title'];
  53                         $r['invalid'] = true;
  54                 } else {
  55                         $titleFactory = MediaWikiServices::getInstance()->getTitleFactory();
  56                         ApiQueryBase::addTitleInfo( $r, $titleFactory->newFromPageIdentity( $pageIdentity ) );
  57                         $r['revisions'] = (int)$successCount;
  58                 }
  59
  60                 $this->mResultArr[] = $r;
  61
  62                 // Piggyback on the parent to do the logging
  63                 parent::reportPage( $pageIdentity, $foreignTitle, $revisionCount, $successCount, $pageInfo );
  64         }
  65
  66         public function getData() {
  67                 return $this->mResultArr;
  68         }
  69 }
  70
  71 /** @deprecated class alias since 1.43 */
  72 class_alias( ApiImportReporter::class, 'ApiImportReporter' );