MediaWiki  REL1_31
LCStoreStaticArray.php
Go to the documentation of this file.
1 <?php
26 class LCStoreStaticArray implements LCStore {
28  private $currentLang = null;
29 
31  private $data = [];
32 
34  private $fname = null;
35 
37  private $directory;
38 
39  public function __construct( $conf = [] ) {
41 
42  if ( isset( $conf['directory'] ) ) {
43  $this->directory = $conf['directory'];
44  } else {
46  }
47  }
48 
49  public function startWrite( $code ) {
50  $this->currentLang = $code;
51  $this->fname = $this->directory . '/' . $code . '.l10n.php';
52  $this->data[$code] = [];
53  if ( file_exists( $this->fname ) ) {
54  $this->data[$code] = require $this->fname;
55  }
56  }
57 
58  public function set( $key, $value ) {
59  $this->data[$this->currentLang][$key] = self::encode( $value );
60  }
61 
69  public static function encode( $value ) {
70  if ( is_scalar( $value ) || $value === null ) {
71  // [V]alue
72  return [ 'v', $value ];
73  }
74  if ( is_object( $value ) ) {
75  // [S]erialized
76  return [ 's', serialize( $value ) ];
77  }
78  if ( is_array( $value ) ) {
79  // [A]rray
80  return [ 'a', array_map( function ( $v ) {
81  return LCStoreStaticArray::encode( $v );
82  }, $value ) ];
83  }
84 
85  throw new RuntimeException( 'Cannot encode ' . var_export( $value, true ) );
86  }
87 
95  public static function decode( array $encoded ) {
96  $type = $encoded[0];
97  $data = $encoded[1];
98 
99  switch ( $type ) {
100  case 'v':
101  return $data;
102  case 's':
103  return unserialize( $data );
104  case 'a':
105  return array_map( function ( $v ) {
106  return LCStoreStaticArray::decode( $v );
107  }, $data );
108  default:
109  throw new RuntimeException(
110  'Unable to decode ' . var_export( $encoded, true ) );
111  }
112  }
113 
114  public function finishWrite() {
115  file_put_contents(
116  $this->fname,
117  "<?php\n" .
118  "// Generated by LCStoreStaticArray.php -- do not edit!\n" .
119  "return " .
120  var_export( $this->data[$this->currentLang], true ) . ';'
121  );
122  $this->currentLang = null;
123  $this->fname = null;
124  }
125 
126  public function get( $code, $key ) {
127  if ( !array_key_exists( $code, $this->data ) ) {
128  $fname = $this->directory . '/' . $code . '.l10n.php';
129  if ( !file_exists( $fname ) ) {
130  return null;
131  }
132  $this->data[$code] = require $fname;
133  }
134  $data = $this->data[$code];
135  if ( array_key_exists( $key, $data ) ) {
136  return self::decode( $data[$key] );
137  }
138  return null;
139  }
140 }
LCStoreStaticArray\finishWrite
finishWrite()
Finish a write transaction.
Definition: LCStoreStaticArray.php:114
LCStoreStaticArray\$currentLang
string null $currentLang
Current language code.
Definition: LCStoreStaticArray.php:28
directory
The most up to date schema for the tables in the database will always be tables sql in the maintenance directory
Definition: schema.txt:2
array
the array() calling protocol came about after MediaWiki 1.4rc1.
LCStoreStaticArray\__construct
__construct( $conf=[])
Definition: LCStoreStaticArray.php:39
unserialize
unserialize( $serialized)
Definition: ApiMessage.php:192
serialize
serialize()
Definition: ApiMessage.php:184
$wgCacheDirectory
$wgCacheDirectory
Directory for caching data in the local filesystem.
Definition: DefaultSettings.php:2252
LCStore
Interface for the persistence layer of LocalisationCache.
Definition: LCStore.php:38
php
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:37
LCStoreStaticArray\$fname
string $fname
File name.
Definition: LCStoreStaticArray.php:34
LCStoreStaticArray\encode
static encode( $value)
Encodes a value into an array format.
Definition: LCStoreStaticArray.php:69
LCStoreStaticArray\$directory
string $directory
Directory for cache files.
Definition: LCStoreStaticArray.php:37
LCStoreStaticArray
Definition: LCStoreStaticArray.php:26
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
$value
$value
Definition: styleTest.css.php:45
LCStoreStaticArray\decode
static decode(array $encoded)
Decode something that was encoded with encode.
Definition: LCStoreStaticArray.php:95
$code
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:865
LCStoreStaticArray\startWrite
startWrite( $code)
Start a write transaction.
Definition: LCStoreStaticArray.php:49
LCStoreStaticArray\$data
array $data
Localisation data.
Definition: LCStoreStaticArray.php:31
data
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
Definition: hooks.txt:18
$type
$type
Definition: testCompression.php:48