includes/import/ImportStringSource.php

   1 <?php
   2 /**
   3  * MediaWiki page data importer.
   4  *
   5  * Copyright © 2003,2005 Brion Vibber <brion@pobox.com>
   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 ineffecient, 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         /**
  36          * @param string $string
  37          */
  38         function __construct( $string ) {
  39                 $this->mString = $string;
  40                 $this->mRead = false;
  41         }
  42
  43         /**
  44          * @return bool
  45          */
  46         function atEnd() {
  47                 return $this->mRead;
  48         }
  49
  50         /**
  51          * @return bool|string
  52          */
  53         function readChunk() {
  54                 if ( $this->atEnd() ) {
  55                         return false;
  56                 }
  57                 $this->mRead = true;
  58                 return $this->mString;
  59         }
  60 }