Translate extension for MediaWiki
 
Loading...
Searching...
No Matches
FlatPhpFormat.php
1<?php
2declare( strict_types = 1 );
3
4namespace MediaWiki\Extension\Translate\FileFormatSupport;
5
10use MediaWiki\Title\Title;
11
21class FlatPhpFormat extends SimpleFormat implements MetaYamlSchemaExtender {
22 public function getFileExtensions(): array {
23 return [ '.php' ];
24 }
25
26 public function readFromVariable( string $data ): array {
27 # Authors first
28 $matches = [];
29 preg_match_all( '/^ \* @author\s+(.+)$/m', $data, $matches );
30 $authors = $matches[1];
31
32 # Then messages
33 $matches = [];
34 $regex = '/^\$(.*?)\s*=\s*[\'"](.*?)[\'"];.*?$/mus';
35 preg_match_all( $regex, $data, $matches, PREG_SET_ORDER );
36 $messages = [];
37
38 foreach ( $matches as $_ ) {
39 $legal = Title::legalChars();
40 $key = preg_replace_callback( "/([^$legal]|\\\\)/u",
41 static function ( $m ) {
42 return '\x' . dechex( ord( $m[0] ) );
43 },
44 $_[1]
45 );
46 $value = str_replace( [ "\'", "\\\\" ], [ "'", "\\" ], $_[2] );
47 $messages[$key] = $value;
48 }
49
50 $messages = $this->group->getMangler()->mangleArray( $messages );
51
52 return [
53 'AUTHORS' => $authors,
54 'MESSAGES' => $messages,
55 ];
56 }
57
58 protected function writeReal( MessageCollection $collection ): string {
59 $output = $this->extra['header'] ?? "<?php\n";
60 $output .= $this->doHeader( $collection );
61
62 $mangler = $this->group->getMangler();
63
65 foreach ( $collection as $item ) {
66 $key = $mangler->unmangle( $item->key() );
67 $key = stripcslashes( $key );
68
69 $value = $item->translation();
70 if ( $value === null ) {
71 continue;
72 }
73
74 $value = str_replace( TRANSLATE_FUZZY, '', $value );
75 $value = addcslashes( $value, "'" );
76
77 $output .= "\$$key = '$value';\n";
78 }
79
80 return $output;
81 }
82
83 private function doHeader( MessageCollection $collection ): string {
84 global $wgServer, $wgTranslateDocumentationLanguageCode;
85
86 $code = $collection->code;
87 $name = Utilities::getLanguageName( $code );
88 $native = Utilities::getLanguageName( $code, $code );
89
90 if ( $wgTranslateDocumentationLanguageCode ) {
91 $docu = "\n * See the $wgTranslateDocumentationLanguageCode 'language' for " .
92 'message documentation incl. usage of parameters';
93 } else {
94 $docu = '';
95 }
96
97 $authors = $this->doAuthors( $collection );
98
99 $output =
100 <<<PHP
111 PHP;
112
113 return $output;
114 }
115
116 private function doAuthors( MessageCollection $collection ): string {
117 $output = '';
118 $authors = $collection->getAuthors();
119 $authors = $this->filterAuthors( $authors, $collection->code );
120
121 foreach ( $authors as $author ) {
122 $output .= " * @author $author\n";
123 }
124
125 return $output;
126 }
127
128 public static function getExtraSchema(): array {
129 return [
130 'root' => [
131 '_type' => 'array',
132 '_children' => [
133 'FILES' => [
134 '_type' => 'array',
135 '_children' => [
136 'header' => [
137 '_type' => 'text',
138 ],
139 ]
140 ]
141 ]
142 ]
143 ];
144 }
145}
146
147class_alias( FlatPhpFormat::class, 'FlatPhpFFS' );
return[ 'Translate:ConfigHelper'=> static function():ConfigHelper { return new ConfigHelper();}, 'Translate:CsvTranslationImporter'=> static function(MediaWikiServices $services):CsvTranslationImporter { return new CsvTranslationImporter( $services->getWikiPageFactory());}, 'Translate:EntitySearch'=> static function(MediaWikiServices $services):EntitySearch { return new EntitySearch($services->getMainWANObjectCache(), $services->getCollationFactory() ->makeCollation( 'uca-default-u-kn'), MessageGroups::singleton(), $services->getNamespaceInfo(), $services->get( 'Translate:MessageIndex'), $services->getTitleParser(), $services->getTitleFormatter());}, 'Translate:ExternalMessageSourceStateImporter'=> static function(MediaWikiServices $services):ExternalMessageSourceStateImporter { return new ExternalMessageSourceStateImporter($services->getMainConfig(), $services->get( 'Translate:GroupSynchronizationCache'), $services->getJobQueueGroup(), LoggerFactory::getInstance( 'Translate.GroupSynchronization'), $services->get( 'Translate:MessageIndex'));}, 'Translate:FileFormatFactory'=> static function(MediaWikiServices $services):FileFormatFactory { return new FileFormatFactory( $services->getObjectFactory());}, 'Translate:GroupSynchronizationCache'=> static function(MediaWikiServices $services):GroupSynchronizationCache { return new GroupSynchronizationCache( $services->get( 'Translate:PersistentCache'));}, 'Translate:HookRunner'=> static function(MediaWikiServices $services):HookRunner { return new HookRunner( $services->getHookContainer());}, 'Translate:MessageBundleStore'=> static function(MediaWikiServices $services):MessageBundleStore { return new MessageBundleStore($services->get( 'Translate:RevTagStore'), $services->getJobQueueGroup(), $services->getLanguageNameUtils(), $services->get( 'Translate:MessageIndex'));}, 'Translate:MessageGroupReviewStore'=> static function(MediaWikiServices $services):MessageGroupReviewStore { return new MessageGroupReviewStore($services->getDBLoadBalancer(), $services->get( 'Translate:HookRunner'));}, 'Translate:MessageGroupStatsTableFactory'=> static function(MediaWikiServices $services):MessageGroupStatsTableFactory { return new MessageGroupStatsTableFactory($services->get( 'Translate:ProgressStatsTableFactory'), $services->getDBLoadBalancer(), $services->getLinkRenderer(), $services->get( 'Translate:MessageGroupReviewStore'), $services->getMainConfig() ->get( 'TranslateWorkflowStates') !==false);}, 'Translate:MessageIndex'=> static function(MediaWikiServices $services):MessageIndex { $params=$services->getMainConfig() ->get( 'TranslateMessageIndex');if(is_string( $params)) { $params=(array) $params;} $class=array_shift( $params);return new $class( $params);}, 'Translate:MessagePrefixStats'=> static function(MediaWikiServices $services):MessagePrefixStats { return new MessagePrefixStats( $services->getTitleParser());}, 'Translate:ParsingPlaceholderFactory'=> static function():ParsingPlaceholderFactory { return new ParsingPlaceholderFactory();}, 'Translate:PersistentCache'=> static function(MediaWikiServices $services):PersistentCache { return new PersistentDatabaseCache($services->getDBLoadBalancer(), $services->getJsonCodec());}, 'Translate:ProgressStatsTableFactory'=> static function(MediaWikiServices $services):ProgressStatsTableFactory { return new ProgressStatsTableFactory($services->getLinkRenderer(), $services->get( 'Translate:ConfigHelper'));}, 'Translate:RevTagStore'=> static function(MediaWikiServices $services):RevTagStore { return new RevTagStore($services->getDBLoadBalancerFactory());}, 'Translate:SubpageListBuilder'=> static function(MediaWikiServices $services):SubpageListBuilder { return new SubpageListBuilder($services->get( 'Translate:TranslatableBundleFactory'), $services->getLinkBatchFactory());}, 'Translate:TranslatableBundleExporter'=> static function(MediaWikiServices $services):TranslatableBundleExporter { return new TranslatableBundleExporter($services->get( 'Translate:SubpageListBuilder'), $services->getWikiExporterFactory(), $services->getDBLoadBalancer());}, 'Translate:TranslatableBundleFactory'=> static function(MediaWikiServices $services):TranslatableBundleFactory { return new TranslatableBundleFactory($services->get( 'Translate:TranslatablePageStore'), $services->get( 'Translate:MessageBundleStore'));}, 'Translate:TranslatableBundleImporter'=> static function(MediaWikiServices $services):TranslatableBundleImporter { return new TranslatableBundleImporter($services->getWikiImporterFactory(), $services->get( 'Translate:TranslatablePageParser'), $services->getRevisionLookup());}, 'Translate:TranslatableBundleMover'=> static function(MediaWikiServices $services):TranslatableBundleMover { return new TranslatableBundleMover($services->getMovePageFactory(), $services->getJobQueueGroup(), $services->getLinkBatchFactory(), $services->get( 'Translate:TranslatableBundleFactory'), $services->get( 'Translate:SubpageListBuilder'), $services->getMainConfig() ->get( 'TranslatePageMoveLimit'));}, 'Translate:TranslatableBundleStatusStore'=> static function(MediaWikiServices $services):TranslatableBundleStatusStore { return new TranslatableBundleStatusStore($services->getDBLoadBalancer() ->getConnection(DB_PRIMARY), $services->getCollationFactory() ->makeCollation( 'uca-default-u-kn'), $services->getDBLoadBalancer() ->getMaintenanceConnectionRef(DB_PRIMARY));}, 'Translate:TranslatablePageParser'=> static function(MediaWikiServices $services):TranslatablePageParser { return new TranslatablePageParser($services->get( 'Translate:ParsingPlaceholderFactory'));}, 'Translate:TranslatablePageStore'=> static function(MediaWikiServices $services):TranslatablePageStore { return new TranslatablePageStore($services->get( 'Translate:MessageIndex'), $services->getJobQueueGroup(), $services->get( 'Translate:RevTagStore'), $services->getDBLoadBalancer(), $services->get( 'Translate:TranslatableBundleStatusStore'), $services->get( 'Translate:TranslatablePageParser'),);}, 'Translate:TranslationStashReader'=> static function(MediaWikiServices $services):TranslationStashReader { $db=$services->getDBLoadBalancer() ->getConnection(DB_REPLICA);return new TranslationStashStorage( $db);}, 'Translate:TranslationStatsDataProvider'=> static function(MediaWikiServices $services):TranslationStatsDataProvider { return new TranslationStatsDataProvider(new ServiceOptions(TranslationStatsDataProvider::CONSTRUCTOR_OPTIONS, $services->getMainConfig()), $services->getObjectFactory(), $services->getDBLoadBalancer());}, 'Translate:TranslationUnitStoreFactory'=> static function(MediaWikiServices $services):TranslationUnitStoreFactory { return new TranslationUnitStoreFactory( $services->getDBLoadBalancer());}, 'Translate:TranslatorActivity'=> static function(MediaWikiServices $services):TranslatorActivity { $query=new TranslatorActivityQuery($services->getMainConfig(), $services->getDBLoadBalancer());return new TranslatorActivity($services->getMainObjectStash(), $query, $services->getJobQueueGroup());}, 'Translate:TtmServerFactory'=> static function(MediaWikiServices $services):TtmServerFactory { $config=$services->getMainConfig();$default=$config->get( 'TranslateTranslationDefaultService');if( $default===false) { $default=null;} return new TtmServerFactory( $config->get( 'TranslateTranslationServices'), $default);}]
@phpcs-require-sorted-array
This file contains the class for core message collections implementation.
Interface for message objects used by MessageCollection.
Definition Message.php:13
Essentially random collection of helper functions, similar to GlobalFunctions.php.
Definition Utilities.php:31
Message groups are usually configured in YAML, though the actual storage format does not matter,...