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...
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
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...
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
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.