{"id":57841,"date":"2023-07-30T16:24:00","date_gmt":"2023-07-30T10:54:00","guid":{"rendered":"https:\/\/tothenewco.pro\/blog\/?p=57841"},"modified":"2023-08-01T16:27:33","modified_gmt":"2023-08-01T10:57:33","slug":"custom-drush-command-to-import-all-po-files","status":"publish","type":"post","link":"https:\/\/tothenewco.pro\/blog\/custom-drush-command-to-import-all-po-files\/","title":{"rendered":"Custom Drush Command to import all .po files"},"content":{"rendered":"

The main purpose of this blog is to create a custom command to import all .po<\/strong> files. In one step\u00a0 Portable Object (.po)<\/strong> file is used for localization and content translation. <\/span><\/p>\n

Let’s start the creation of a custom drush command to import .po files:<\/p>\n

Step 1.\u00a0 Create Module<\/strong><\/h2>\n

Create a <\/span>.info.yml<\/b> file<\/span><\/p>\n

name<\/span>: <\/span>Custom Drush<\/span>\r\n\r\ntype<\/span>: <\/span>module<\/span>\r\n\r\ndescription<\/span>: <\/span>This module is used to create custom drush command to import *.po files<\/span>\r\n\r\npackage<\/span>: <\/span>Custom<\/span>\r\n\r\ncore_version_requirement<\/span>: <\/span>8.x || 9.x<\/span><\/pre>\n
Step 2: Create a service using services.yml<\/b><\/span><\/h2>\n
Create a drush.services.yml<\/strong> file<\/span><\/p>\n
services<\/span>:<\/span>\r\n\r\n\u00a0<\/span>custom_drush.commands<\/span>:<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>class<\/span>: <\/span>\\Drupal\\<\/span>custom_drush<\/span>\\Commands\\AllDrushCommands<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>tags<\/span>:<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0- { <\/span>name<\/span>: <\/span>drush.command<\/span> }<\/span><\/pre>\n
Step 3: Create a Drush Class<\/b><\/h2>\n
Now let\u2019s extend the DrushCommands base class.<\/span><\/p>\n
Path :<\/strong> custom_drush\/src\/Commands\/AllDrushCommands.php<\/span><\/p>\n
<?php<\/span>\r\n\r\nnamespace<\/span> Drupal\\custom_drush\\Commands<\/span>;<\/span>\r\n\r\nuse<\/span> Drush\\Commands\\<\/span>DrushCommands<\/span>;<\/span>\r\n\r\n\/**<\/span>\r\n\r\n* A Drush commandfile.<\/span>\r\n\r\n*<\/span>\r\n\r\n* In addition to this file, you need a drush.services.yml<\/span>\r\n\r\n* in root of your module, and a composer.json file that provides the name<\/span>\r\n\r\n* of the services file to use.<\/span>\r\n\r\n*\/<\/span>\r\n\r\nclass<\/span> AllDrushCommands<\/span> extends<\/span> DrushCommands<\/span> {<\/span>\r\n\r\n\/**<\/span>\r\n\r\n\u00a0\u00a0*<\/span>\r\n\r\n\u00a0\u00a0* @command custom_drush:ImportPoFiles<\/span>\r\n\r\n\u00a0\u00a0* @aliases import_po_files<\/span>\r\n\r\n\u00a0\u00a0* @usage custom_drush:cmgImportPo<\/span>\r\n\r\n\u00a0\u00a0* \u00a0 import all .po files.<\/span>\r\n\r\n\u00a0\u00a0*\/<\/span>\r\n\r\n\u00a0\u00a0<\/span>public<\/span> function<\/span> ImportPoFiles<\/span>() {<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>$today<\/span> = <\/span>date<\/span>(<\/span>\"Y-m-d\"<\/span>);<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>$langcodes<\/span> = \\<\/span>Drupal<\/span>::<\/span>languageManager<\/span>()-><\/span>getLanguages<\/span>();<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>$langcodesList<\/span> = <\/span>array_keys<\/span>(<\/span>$langcodes<\/span>);<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>\/\/ Get all .po files.<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>$arrFiles<\/span> = <\/span>glob<\/span>(DRUPAL_ROOT .<\/span>'\/*.po'<\/span>);<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>$this<\/span>-><\/span>output<\/span>()-><\/span>writeln<\/span>(<\/span>'Importing po files'<\/span>);<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>$starttimer<\/span> = <\/span>'importingpofiles'<\/span>;<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>Timer<\/span>::<\/span>start<\/span>(<\/span>$starttimer<\/span>);<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>foreach<\/span>(<\/span>$arrFiles<\/span> as <\/span>$file<\/span>){<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>$file<\/span> = <\/span>end<\/span>(<\/span>explode<\/span>(<\/span>'\/'<\/span>,<\/span>$file<\/span>));<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>$file_langcode<\/span> = <\/span>substr<\/span>(<\/span>$file<\/span>,<\/span>0<\/span>,<\/span>strlen<\/span>(<\/span>$file<\/span>)-<\/span>3<\/span>);<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>if<\/span> (<\/span>in_array<\/span>(<\/span>$file_langcode<\/span>, <\/span>$langcodesList<\/span>)){<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>importPoTranslations<\/span>([<\/span>$file<\/span>]);<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0}<\/span>\r\n\r\n\u00a0\u00a0\u00a0}<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>drush_backend_batch_process<\/span>();<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>\/\/ Time taken.<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>$this<\/span>-><\/span>output<\/span>()-><\/span>writeln<\/span>(<\/span>'Time taken for importing .po files (seconds) = '<\/span> . (<\/span>Timer<\/span>::<\/span>read<\/span>(<\/span>$starttimer<\/span>) \/ <\/span>1000<\/span>));<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>$timer_stats<\/span> = <\/span>Timer<\/span>::<\/span>stop<\/span>(<\/span>$starttimer<\/span>)<\/span>\r\n\r\n\u00a0}<\/span>\r\n\r\n}<\/span><\/pre>\n
Step 4: Create a method used in drush class<\/b><\/h2>\n
\n
\/**\r\n\r\n* Function : importPoTranslations\r\n\r\n* Param : Array\r\n\r\n* Description : To import po files\r\n\r\n*\/\r\n\r\nfunction importPoTranslations( array $poFiles) {\r\n\r\n\\Drupal::moduleHandler()->loadInclude('locale', 'translation.inc');\r\n\r\n\\Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');\r\n\r\n$importer_options = array();\r\n\r\n$opt_langcode = '';\r\n\r\n$opt_set_customized = TRUE;\r\n\r\n$opt_replace_customized = TRUE;\r\n\r\n$opt_replace_not_customized = TRUE;\r\n\r\n\/\/ Import language files.\r\n\r\n$files = [];\r\n\r\n$langcodes_to_import = [];\r\n\r\nforeach ($poFiles as $file_path) {\r\n\r\n\/\/ Ensure we have the file intended for upload.\r\n\r\nif (file_exists($file_path)) {\r\n\r\n$opt_langcode = substr($file_path,0,strlen($file_path)-3);\r\n\r\n$importer_options = array_merge(_locale_translation_default_update_options(), [\r\n\r\n'langcode' => $opt_langcode,\r\n\r\n'customized' => $opt_set_customized ? LOCALE_CUSTOMIZED : LOCALE_NOT_CUSTOMIZED,\r\n\r\n'overwrite_options' => [\r\n\r\n'customized' => (int) $opt_replace_customized,\r\n\r\n'not_customized' => (int) $opt_replace_not_customized,\r\n\r\n],\r\n\r\n]);\r\n\r\n$file = locale_translate_file_create($file_path);\r\n\r\n$file = locale_translate_file_attach_properties($file, $importer_options);\r\n\r\nif ($file->langcode == LanguageInterface::LANGCODE_NOT_SPECIFIED) {\r\n\r\nif (!$opt_langcode) {\r\n\r\n\\Drupal::logger('update')\r\n\r\n->error(t('Can not autodetect language of file @file', ['@file' => $file_path]));\r\n\r\nreturn;\r\n\r\n}\r\n\r\n$file->langcode = $opt_langcode;\r\n\r\nif (empty($file->version) && !empty($file->project) && !empty($file->langcode)) {\r\n\r\n$sources = locale_translation_get_status();\r\n\r\n$source = $sources[$file->project][$file->langcode];\r\n\r\nif (isset($source->version)) {\r\n\r\n$file->version = $source->version;\r\n\r\n}\r\n\r\n}\r\n\r\n}\r\n\r\n$langcodes_to_import[$file->langcode] = $file->langcode;\r\n\r\n$files[] = $file;\r\n\r\n}\r\n\r\nelse {\r\n\r\n\\Drupal::logger('update')\r\n\r\n->error(t('File to import at @filepath not found.', ['@filepath' => $file_path]));\r\n\r\n}\r\n\r\n}\r\n\r\n$batch = locale_translate_batch_build($files, $importer_options);\r\n\r\nbatch_set($batch);\r\n\r\n\/\/ Create or update all configuration translations for this language.\r\n\r\nif ($batch = locale_config_batch_update_components($importer_options, $langcodes_to_import)) {\r\n\r\nbatch_set($batch);\r\n\r\n}\r\n\r\n}<\/pre>\n
\n
Step 5: Clear the cache<\/b><\/h2>\n
Now let\u2019s clear the cache to flush all caches with this command:<\/span><\/p>\n
drush cr<\/b><\/pre>\n
Now you can use the new command to import *.po files<\/span><\/p>\n
drush import_po_files<\/pre>\n
Conclusion<\/strong><\/h2>\n
Finally, using this command on a multilingual website, you can import all .po files. No need to import the .po file one by one from the backend.\u00a0<\/span><\/p>\n
Let us know in case of any queries, and please feel free to reach out via comments.<\/span><\/p>\n<\/div>\n<\/div>\n
<\/div>","protected":false},"excerpt":{"rendered":"
The main purpose of this blog is to create a custom command to import all .po files. In one step\u00a0 Portable Object (.po) file is used for localization and content translation. Let’s start the creation of a custom drush command to import .po files: Step 1.\u00a0 Create Module Create a .info.yml file name: Custom Drush […]<\/p>\n","protected":false},"author":1599,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":24,"footnotes":""},"categories":[3602],"tags":[4884,5299],"class_list":["post-57841","post","type-post","status-publish","format-standard","hentry","category-drupal","tag-drupal-9","tag-multilingual"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t