includes/import/ImportStringSource.php

   1 <?php
   2 /**
   3  * MediaWiki page data importer.
   4  *
   5  * Copyright © 2003,2005 Brooke Vibber <bvibber@wikimedia.org>
   6  * https://www.mediawiki.org/
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  * @ingroup SpecialPage
  25  */
  26
  27 /**
  28  * Used for importing XML dumps where the content of the dump is in a string.
  29  * This class is inefficient, and should only be used for small dumps.
  30  * For larger dumps, ImportStreamSource should be used instead.
  31  *
  32  * @ingroup SpecialPage
  33  */
  34 class ImportStringSource implements ImportSource {
  35         /** @var string */
  36         private $mString;
  37
  38         /** @var bool */
  39         private $mRead = false;
  40
  41         /**
  42          * @param string $string
  43          */
  44         public function __construct( $string ) {
  45                 $this->mString = $string;
  46         }
  47
  48         /**
  49          * @return bool
  50          */
  51         public function atEnd() {
  52                 return $this->mRead;
  53         }
  54
  55         /**
  56          * @return bool|string
  57          */
  58         public function readChunk() {
  59                 if ( $this->atEnd() ) {
  60                         return false;
  61                 }
  62                 $this->mRead = true;
  63                 return $this->mString;
  64         }
  65
  66         /**
  67          * @return bool
  68          */
  69         public function isSeekable() {
  70                 return true;
  71         }
  72
  73         /**
  74          * @param int $offset
  75          * @return int
  76          */
  77         public function seek( int $offset ) {
  78                 $this->mRead = false;
  79                 return 0;
  80         }
  81 }