MediaWiki  1.28.0
DatabaseDomain.php
Go to the documentation of this file.
1 <?php
27  private $database;
29  private $schema;
31  private $prefix;
32 
35 
41  public function __construct( $database, $schema, $prefix ) {
42  if ( $database !== null && ( !is_string( $database ) || !strlen( $database ) ) ) {
43  throw new InvalidArgumentException( "Database must be null or a non-empty string." );
44  }
45  $this->database = $database;
46  if ( $schema !== null && ( !is_string( $schema ) || !strlen( $schema ) ) ) {
47  throw new InvalidArgumentException( "Schema must be null or a non-empty string." );
48  }
49  $this->schema = $schema;
50  if ( !is_string( $prefix ) ) {
51  throw new InvalidArgumentException( "Prefix must be a string." );
52  }
53  $this->prefix = $prefix;
54  }
55 
60  public static function newFromId( $domain ) {
61  if ( $domain instanceof self ) {
62  return $domain;
63  }
64 
65  $parts = array_map( [ __CLASS__, 'decode' ], explode( '-', $domain ) );
66 
67  $schema = null;
68  $prefix = '';
69 
70  if ( count( $parts ) == 1 ) {
71  $database = $parts[0];
72  } elseif ( count( $parts ) == 2 ) {
73  list( $database, $prefix ) = $parts;
74  } elseif ( count( $parts ) == 3 ) {
75  list( $database, $schema, $prefix ) = $parts;
76  } else {
77  throw new InvalidArgumentException( "Domain has too few or too many parts." );
78  }
79 
80  if ( $database === '' ) {
81  $database = null;
82  }
83 
84  return new self( $database, $schema, $prefix );
85  }
86 
90  public static function newUnspecified() {
91  return new self( null, null, '' );
92  }
93 
98  public function equals( $other ) {
99  if ( $other instanceof DatabaseDomain ) {
100  return (
101  $this->database === $other->database &&
102  $this->schema === $other->schema &&
103  $this->prefix === $other->prefix
104  );
105  }
106 
107  return ( $this->getId() === $other );
108  }
109 
113  public function getDatabase() {
114  return $this->database;
115  }
116 
120  public function getSchema() {
121  return $this->schema;
122  }
123 
127  public function getTablePrefix() {
128  return $this->prefix;
129  }
130 
134  public function getId() {
135  if ( $this->equivalentString === null ) {
136  $this->equivalentString = $this->convertToString();
137  }
138 
140  }
141 
145  private function convertToString() {
146  $parts = [ $this->database ];
147  if ( $this->schema !== null ) {
148  $parts[] = $this->schema;
149  }
150  if ( $this->prefix != '' ) {
151  $parts[] = $this->prefix;
152  }
153 
154  return implode( '-', array_map( [ __CLASS__, 'encode' ], $parts ) );
155  }
156 
157  private static function encode( $decoded ) {
158  $encoded = '';
159 
160  $length = strlen( $decoded );
161  for ( $i = 0; $i < $length; ++$i ) {
162  $char = $decoded[$i];
163  if ( $char === '-' ) {
164  $encoded .= '?h';
165  } elseif ( $char === '?' ) {
166  $encoded .= '??';
167  } else {
168  $encoded .= $char;
169  }
170  }
171 
172  return $encoded;
173  }
174 
175  private static function decode( $encoded ) {
176  $decoded = '';
177 
178  $length = strlen( $encoded );
179  for ( $i = 0; $i < $length; ++$i ) {
180  $char = $encoded[$i];
181  if ( $char === '?' ) {
182  $nextChar = isset( $encoded[$i + 1] ) ? $encoded[$i + 1] : null;
183  if ( $nextChar === 'h' ) {
184  $decoded .= '-';
185  ++$i;
186  } elseif ( $nextChar === '?' ) {
187  $decoded .= '?';
188  ++$i;
189  } else {
190  $decoded .= $char;
191  }
192  } else {
193  $decoded .= $char;
194  }
195  }
196 
197  return $decoded;
198  }
199 
203  function __toString() {
204  return $this->getId();
205  }
206 }
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
static newUnspecified()
string $equivalentString
Cache of convertToString()
static decode($encoded)
string null $schema
__construct($database, $schema, $prefix)
Class to handle database/prefix specification for IDatabase domains.
static encode($decoded)
string null $database
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the database
Definition: design.txt:12
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
static newFromId($domain)