MediaWiki  master
NamespaceAwareForeignTitleFactory.php
Go to the documentation of this file.
1 <?php
29  protected $foreignNamespaces;
34 
40  private function normalizeNamespaceName( $name ) {
41  return strtolower( str_replace( ' ', '_', $name ) );
42  }
43 
51  public function __construct( $foreignNamespaces ) {
52  $this->foreignNamespaces = $foreignNamespaces;
53  if ( !is_null( $foreignNamespaces ) ) {
54  $this->foreignNamespacesFlipped = [];
55  foreach ( $foreignNamespaces as $id => $name ) {
56  $newKey = self::normalizeNamespaceName( $name );
57  $this->foreignNamespacesFlipped[$newKey] = $id;
58  }
59  }
60  }
61 
71  public function createForeignTitle( $title, $ns = null ) {
72  // Export schema version 0.5 and earlier (MW 1.18 and earlier) does not
73  // contain a <ns> tag, so we need to be able to handle that case.
74  if ( is_null( $ns ) ) {
75  return self::parseTitleNoNs( $title );
76  } else {
77  return self::parseTitleWithNs( $title, $ns );
78  }
79  }
80 
87  protected function parseTitleNoNs( $title ) {
88  $pieces = explode( ':', $title, 2 );
89  $key = self::normalizeNamespaceName( $pieces[0] );
90 
91  // Does the part before the colon match a known namespace? Check the
92  // foreign namespaces
93  $isNamespacePartValid = isset( $this->foreignNamespacesFlipped[$key] );
94 
95  if ( count( $pieces ) === 2 && $isNamespacePartValid ) {
96  list( $namespaceName, $pageName ) = $pieces;
97  $ns = $this->foreignNamespacesFlipped[$key];
98  } else {
99  $namespaceName = '';
100  $pageName = $title;
101  $ns = 0;
102  }
103 
104  return new ForeignTitle( $ns, $namespaceName, $pageName );
105  }
106 
114  protected function parseTitleWithNs( $title, $ns ) {
115  $pieces = explode( ':', $title, 2 );
116 
117  // Is $title of the form Namespace:Title (true), or just Title (false)?
118  $titleIncludesNamespace = ( $ns != '0' && count( $pieces ) === 2 );
119 
120  if ( isset( $this->foreignNamespaces[$ns] ) ) {
121  $namespaceName = $this->foreignNamespaces[$ns];
122  } else {
123  // If the foreign wiki is misconfigured, XML dumps can contain a page with
124  // a non-zero namespace ID, but whose title doesn't contain a colon
125  // (T114115). In those cases, output a made-up namespace name to avoid
126  // collisions. The ImportTitleFactory might replace this with something
127  // more appropriate.
128  $namespaceName = $titleIncludesNamespace ? $pieces[0] : "Ns$ns";
129  }
130 
131  // We assume that the portion of the page title before the colon is the
132  // namespace name, except in the case of namespace 0.
133  if ( $titleIncludesNamespace ) {
134  $pageName = $pieces[1];
135  } else {
136  $pageName = $title;
137  }
138 
139  return new ForeignTitle( $ns, $namespaceName, $pageName );
140  }
141 }
A parser that translates page titles on a foreign wiki into ForeignTitle objects, using information a...
parseTitleWithNs( $title, $ns)
Helper function to parse the title when the namespace value is known.
A parser that translates page titles into ForeignTitle objects.
normalizeNamespaceName( $name)
Normalizes an array name for $foreignNamespacesFlipped.
createForeignTitle( $title, $ns=null)
Creates a ForeignTitle object based on the page title, and optionally the namespace ID...
A simple, immutable structure to hold the title of a page on a foreign MediaWiki installation.
parseTitleNoNs( $title)
Helper function to parse the title when the namespace ID is not specified.