MediaWiki  master
SiteExporter.php
Go to the documentation of this file.
1 <?php
2 
30 class SiteExporter {
31 
35  private $sink;
36 
40  public function __construct( $sink ) {
41  if ( !is_resource( $sink ) || get_resource_type( $sink ) !== 'stream' ) {
42  throw new InvalidArgumentException( '$sink must be a file handle' );
43  }
44 
45  $this->sink = $sink;
46  }
47 
54  public function exportSites( $sites ) {
55  $attributes = [
56  'version' => '1.0',
57  'xmlns' => 'http://www.mediawiki.org/xml/sitelist-1.0/',
58  ];
59 
60  fwrite( $this->sink, Xml::openElement( 'sites', $attributes ) . "\n" );
61 
62  foreach ( $sites as $site ) {
63  $this->exportSite( $site );
64  }
65 
66  fwrite( $this->sink, Xml::closeElement( 'sites' ) . "\n" );
67  fflush( $this->sink );
68  }
69 
75  private function exportSite( Site $site ) {
76  if ( $site->getType() !== Site::TYPE_UNKNOWN ) {
77  $siteAttr = [ 'type' => $site->getType() ];
78  } else {
79  $siteAttr = null;
80  }
81 
82  fwrite( $this->sink, "\t" . Xml::openElement( 'site', $siteAttr ) . "\n" );
83 
84  fwrite( $this->sink, "\t\t" . Xml::element( 'globalid', null, $site->getGlobalId() ) . "\n" );
85 
86  if ( $site->getGroup() !== Site::GROUP_NONE ) {
87  fwrite( $this->sink, "\t\t" . Xml::element( 'group', null, $site->getGroup() ) . "\n" );
88  }
89 
90  if ( $site->getSource() !== Site::SOURCE_LOCAL ) {
91  fwrite( $this->sink, "\t\t" . Xml::element( 'source', null, $site->getSource() ) . "\n" );
92  }
93 
94  if ( $site->shouldForward() ) {
95  fwrite( $this->sink, "\t\t" . Xml::element( 'forward', null, '' ) . "\n" );
96  }
97 
98  foreach ( $site->getAllPaths() as $type => $path ) {
99  fwrite( $this->sink, "\t\t" . Xml::element( 'path', [ 'type' => $type ], $path ) . "\n" );
100  }
101 
102  foreach ( $site->getLocalIds() as $type => $ids ) {
103  foreach ( $ids as $id ) {
104  fwrite( $this->sink, "\t\t" . Xml::element( 'localid', [ 'type' => $type ], $id ) . "\n" );
105  }
106  }
107 
108  // @todo: export <data>
109  // @todo: export <config>
110 
111  fwrite( $this->sink, "\t" . Xml::closeElement( 'site' ) . "\n" );
112  }
113 
114 }
exportSite(Site $site)
Writes a <site> tag representing the given Site object.
__construct( $sink)
getSource()
Returns the source of the site data (ie &#39;local&#39;, &#39;wikidata&#39;, &#39;my-magical-repo&#39;).
Definition: Site.php:207
getLocalIds()
Returns all local ids.
Definition: Site.php:573
getGroup()
Gets the group of the site (ie wikipedia).
Definition: Site.php:179
static openElement( $element, $attribs=null)
This opens an XML element.
Definition: Xml.php:108
resource $sink
getAllPaths()
Returns the paths as associative array.
Definition: Site.php:622
const TYPE_UNKNOWN
Definition: Site.php:30
const SOURCE_LOCAL
Definition: Site.php:38
const GROUP_NONE
Definition: Site.php:33
shouldForward()
Gets if site.tld/path/key:pageTitle should forward users to the page on the actual site...
Definition: Site.php:236
static closeElement( $element)
Shortcut to close an XML element.
Definition: Xml.php:117
getGlobalId()
Returns the global site identifier (ie enwiktionary).
Definition: Site.php:140
Definition: Site.php:29
getType()
Returns the type of the site (ie mediawiki).
Definition: Site.php:168
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:41
exportSites( $sites)
Writes a <site> tag for each Site object in $sites, and encloses the entire list between <sites> tags...