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