translationCatalogueBuilder = $translationCatalogueBuilder; $this->providerDefinitionFactory = $providerDefinitionFactory; $this->dumper = $dumper; $this->filesystem = $filesystem; $this->exportDir = $exportDir; $this->zipManager = $zipManager; } /** * Exports the translation catalogues depending on the selections provided in the given locale. * Catalogues are written in XLF files and stored in a folder with the locale name. * This folder is then compressed in a zip file. The returned value is the path of the created zip file. * * The expected format for $selections parameter is * [ * [ * 'type' => string, // Translation type, allowed in ProviderDefinitionInterface::ALLOWED_EXPORT_TYPES * 'selected' => string|null // Must be defined if translation type is themes or modules, otherwise NULL * ], * ... * ] * * @param array $selections * @param string $locale * * @return string The zip file with catalogues exported * * @throws TranslationFilesNotFoundException * @throws UnexpectedTranslationTypeException * @throws IOException */ public function export(array $selections, string $locale): string { $this->validateParameters($selections); // Create directory, where we will do our exports, if it doesn't exist // This is var/cache//export if (!$this->filesystem->exists($this->exportDir)) { $this->filesystem->mkdir($this->exportDir); } // Prepare unique export identifier so we don't interfere with other exports $exportIdentifier = uniqid(); // Create our working folder, this is a temporary folder inside var/cache//export $workingFolder = $this->exportDir . '/' . $exportIdentifier; if (!$this->filesystem->exists($workingFolder)) { $this->filesystem->mkdir($workingFolder); } // Prepare the name of the final zip file we will return $zipFilename = sprintf('%s/translations_export_%s.zip', $this->exportDir, $locale); // Dump all XLF files into var/cache//export// foreach ($selections as $selection) { $providerDefinition = $this->providerDefinitionFactory->build($selection['type'], $selection['selected']); // Get the catalogue Map $catalogue = $this->translationCatalogueBuilder->getRawCatalogue($providerDefinition, $locale, []); // Transform into messageCatalogue object $messageCatalogue = $this->transformCatalogueMapToMessageCatalogue($catalogue, $locale); // Dump catalogue into XLF files into our temporary folder $this->dumper->dump( $messageCatalogue, [ 'path' => $workingFolder, 'default_locale' => $locale, 'root_dir' => _PS_ROOT_DIR_ . DIRECTORY_SEPARATOR, 'split_files' => false, ] ); } // Now, we append the locale to the names of the catalogues $this->renameCatalogues($locale, $workingFolder); // Zip them $this->zipManager->createArchive($zipFilename, $workingFolder); // And clean after ourselves $this->filesystem->remove($workingFolder); return $zipFilename; } /** * @param array $selections Translation types to export * * @throws UnexpectedTranslationTypeException * @throws Exception */ private function validateParameters( array $selections ): void { foreach ($selections as $selection) { if (!in_array($selection['type'], ProviderDefinitionInterface::ALLOWED_EXPORT_TYPES, true)) { throw new UnexpectedTranslationTypeException('This \'type\' param is not valid.'); } if ( null === $selection['selected'] && in_array($selection['type'], [ProviderDefinitionInterface::TYPE_MODULES, ProviderDefinitionInterface::TYPE_THEMES], true) ) { throw new Exception(sprintf('Selected value cannot be null for type %s.', $selection['type'])); } } } private function transformCatalogueMapToMessageCatalogue(Catalogue $catalogue, string $locale): MessageCatalogue { $messageCatalogue = new MessageCatalogue($locale); foreach ($catalogue->getDomains() as $domain) { $domainName = $domain->getDomainName(); foreach ($domain->getMessages() as $message) { $messageCatalogue->set($message->getKey(), $message->getTranslation(), $domainName); $messageCatalogue->setMetadata($message->getKey(), ['file' => '', 'line' => ''], $domainName); } } return $messageCatalogue; } /** * After export, our files are named with their domain only, FullDomainName.xlf for example. * This method will append the locale name to the end of the file, so the result is something like * FullDomainName.ab-AB.xlf * * @param string $locale Locale to append to filenames * @param string $path Folder to work in */ protected function renameCatalogues(string $locale, string $path): void { $finder = Finder::create(); foreach ($finder->in($path . DIRECTORY_SEPARATOR . $locale)->files() as $file) { $currentName = $file->getPathname(); $newName = preg_replace('/\.xlf$/', '.' . $locale . '.xlf', $currentName); $this->filesystem->rename($currentName, $newName); } } }