27466302243

Committed 13 Jun 2026 12:06PM UTC coverage: 89.097% (+0.003%) from 89.094%

Build # 27466302243

Build Type

push

github

Committed by

web-flow

Commit Message

refactor: migrate `lang:*` commands as modern commands (#10306)

Coverage Stats

109 of 122 new or added lines in 2 files covered. (89.34%)

1 existing line in 1 file now uncovered.

24956 of 28010 relevant lines covered (89.1%)

224.23 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.96

/system/Commands/Translation/LocalizationSync.php

<?php

declare(strict_types=1);

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Commands\Translation;

use CodeIgniter\CLI\AbstractCommand;
use CodeIgniter\CLI\Attributes\Command;
use CodeIgniter\CLI\CLI;
use CodeIgniter\CLI\Input\Option;
use CodeIgniter\Exceptions\LogicException;
use Config\App;
use ErrorException;
use FilesystemIterator;
use Locale;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use SplFileInfo;

/**
 * Synchronizes translation files from one language to another.
 */
#[Command(
    name: 'lang:sync',
    description: 'Synchronize translation files from one language to another.',
    group: 'Translation',
)]
class LocalizationSync extends AbstractCommand
{
    private string $languagePath;

    protected function configure(): void
    {
        $this
            ->addOption(new Option(
                name: 'locale',
                description: 'The original locale (en, ru, etc.).',
                requiresValue: true,
                default: '',
            ))
            ->addOption(new Option(
                name: 'target',
                description: 'Target locale (en, ru, etc.).',
                requiresValue: true,
                default: '',
            ));
    }

    protected function execute(array $arguments, array $options): int
    {
        $locale = $options['locale'];
        assert(is_string($locale));

        $target = $options['target'];
        assert(is_string($target));

        $this->languagePath = APPPATH . 'Language';
        $supportedLocales   = config(App::class)->supportedLocales;

        if ($locale === '') {
            $locale = Locale::getDefault();
        }

        if (! in_array($locale, $supportedLocales, true)) {
            return $this->errorUnsupportedLocale($locale);
        }

        if ($target === '') {
            CLI::error(
                sprintf(
                    'Error: "--target" is not configured. Supported locales: %s',
                    implode(', ', $supportedLocales),
                ),
                'light_gray',
                'red',
            );

            return EXIT_USER_INPUT;
        }

        if (! in_array($target, $supportedLocales, true)) {
            return $this->errorUnsupportedLocale($target);
        }

        if ($target === $locale) {
            CLI::error('Error: You cannot have the same values for "--target" and "--locale".', 'light_gray', 'red');

            return EXIT_USER_INPUT;
        }

        if (service('environment')->isTesting()) {
            $this->languagePath = SUPPORTPATH . 'Language';
        }

        if ($this->process($locale, $target) === EXIT_ERROR) {
            return EXIT_ERROR;
        }

        CLI::write('All operations done!', 'green');

        return EXIT_SUCCESS;
    }

    /**
     * Writes the unsupported-locale error and returns the user-input exit code.
     */
    private function errorUnsupportedLocale(string $locale): int
    {
        CLI::error(
            sprintf(
                'Error: "%s" is not supported. Supported locales: %s',
                $locale,
                implode(', ', config(App::class)->supportedLocales),
            ),
            'light_gray',
            'red',
        );

        return EXIT_USER_INPUT;
    }

    private function process(string $originalLocale, string $targetLocale): int
    {
        $originalLocaleDir = $this->languagePath . DIRECTORY_SEPARATOR . $originalLocale;
        $targetLocaleDir   = $this->languagePath . DIRECTORY_SEPARATOR . $targetLocale;

        if (! is_dir($originalLocaleDir)) {
            CLI::error(
                sprintf('Error: The "%s" directory was not found.', clean_path($originalLocaleDir)),
                'light_gray',
                'red',
            );

            return EXIT_ERROR;
        }

        // Unifying the error - mkdir() may cause an exception.
        try {
            if (! is_dir($targetLocaleDir) && ! mkdir($targetLocaleDir, 0775)) {
                throw new ErrorException();
            }
        } catch (ErrorException $e) {
            CLI::error(
                sprintf('Error: The target directory "%s" cannot be accessed.', clean_path($targetLocaleDir)),
                'light_gray',
                'red',
            );

            return EXIT_ERROR;
        }

        $iterator = new RecursiveIteratorIterator(
            new RecursiveDirectoryIterator(
                $originalLocaleDir,
                FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS,
            ),
        );

        $files = iterator_to_array($iterator);
        ksort($files);

        /** @var SplFileInfo $originalLanguageFile */
        foreach ($files as $originalLanguageFile) {
            if ($originalLanguageFile->getExtension() !== 'php') {
                continue;
            }

            $targetLanguageFile = $targetLocaleDir . DIRECTORY_SEPARATOR . $originalLanguageFile->getFilename();

            $targetLanguageKeys   = [];
            $originalLanguageKeys = include $originalLanguageFile;

            if (is_file($targetLanguageFile)) {
                $targetLanguageKeys = include $targetLanguageFile;
            }

            $targetLanguageKeys = $this->mergeLanguageKeys($originalLanguageKeys, $targetLanguageKeys, $originalLanguageFile->getBasename('.php'));

            $content = "<?php\n\nreturn " . var_export($targetLanguageKeys, true) . ";\n";
            file_put_contents($targetLanguageFile, $content);
        }

        return EXIT_SUCCESS;
    }

    /**
     * @param array<string, array<string,mixed>|string|null> $originalLanguageKeys
     * @param array<string, array<string,mixed>|string|null> $targetLanguageKeys
     *
     * @return array<string, array<string,mixed>|string|null>
     */
    private function mergeLanguageKeys(array $originalLanguageKeys, array $targetLanguageKeys, string $prefix = ''): array
    {
        $mergedLanguageKeys = [];

        foreach ($originalLanguageKeys as $key => $value) {
            $placeholderValue = $prefix !== '' ? $prefix . '.' . $key : $key;

            if (is_string($value)) {
                // Keep the old value
                // TODO: The value type may not match the original one
                if (array_key_exists($key, $targetLanguageKeys)) {
                    $mergedLanguageKeys[$key] = $targetLanguageKeys[$key];

                    continue;
                }

                // Set new key with placeholder
                $mergedLanguageKeys[$key] = $placeholderValue;
            } elseif (is_array($value)) {
                if (! array_key_exists($key, $targetLanguageKeys)) {
                    $mergedLanguageKeys[$key] = $this->mergeLanguageKeys($value, [], $placeholderValue);

                    continue;
                }

                $mergedLanguageKeys[$key] = $this->mergeLanguageKeys($value, $targetLanguageKeys[$key], $placeholderValue);
            } else {
                throw new LogicException(sprintf(
                    'Value for the key "%s" is of the wrong type. Only "array" or "string" is allowed.',
                    $placeholderValue,
                ));
            }
        }

        return $mergedLanguageKeys;
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/**
6	* This file is part of CodeIgniter 4 framework.
7	*
8	* (c) CodeIgniter Foundation <admin@codeigniter.com>
9	*
10	* For the full copyright and license information, please view
11	* the LICENSE file that was distributed with this source code.
12	*/
13
14	namespace CodeIgniter\Commands\Translation;
15
16	use CodeIgniter\CLI\AbstractCommand;
17	use CodeIgniter\CLI\Attributes\Command;
18	use CodeIgniter\CLI\CLI;
19	use CodeIgniter\CLI\Input\Option;
20	use CodeIgniter\Exceptions\LogicException;
21	use Config\App;
22	use ErrorException;
23	use FilesystemIterator;
24	use Locale;
25	use RecursiveDirectoryIterator;
26	use RecursiveIteratorIterator;
27	use SplFileInfo;
28
29	/**
30	* Synchronizes translation files from one language to another.
31	*/
32	#[Command(
33	name: 'lang:sync',
34	description: 'Synchronize translation files from one language to another.',
35	group: 'Translation',
36	)]
37	class LocalizationSync extends AbstractCommand
38	{
39	private string $languagePath;
40
41	protected function configure(): void
42	{
43	$this	8✔
44	->addOption(new Option(	8✔
45	name: 'locale',	8✔
46	description: 'The original locale (en, ru, etc.).',	8✔
47	requiresValue: true,	8✔
48	default: '',	8✔
49	))	8✔
50	->addOption(new Option(	8✔
51	name: 'target',	8✔
52	description: 'Target locale (en, ru, etc.).',	8✔
53	requiresValue: true,	8✔
54	default: '',	8✔
55	));	8✔
56	}
57
58	protected function execute(array $arguments, array $options): int
59	{
60	$locale = $options['locale'];	7✔
61	assert(is_string($locale));
62
63	$target = $options['target'];	7✔
64	assert(is_string($target));
65
66	$this->languagePath = APPPATH . 'Language';	7✔
67	$supportedLocales = config(App::class)->supportedLocales;	7✔
68
69	if ($locale === '') {	7✔
70	$locale = Locale::getDefault();	4✔
71	}
72
73	if (! in_array($locale, $supportedLocales, true)) {	7✔
74	return $this->errorUnsupportedLocale($locale);	1✔
75	}
76
77	if ($target === '') {	6✔
78	CLI::error(	×
NEW 79	sprintf(	×
NEW 80	'Error: "--target" is not configured. Supported locales: %s',	×
NEW 81	implode(', ', $supportedLocales),	×
NEW 82	),	×
NEW 83	'light_gray',	×
NEW 84	'red',	×
UNCOV 85	);	×
86
87	return EXIT_USER_INPUT;	×
88	}
89
90	if (! in_array($target, $supportedLocales, true)) {	6✔
91	return $this->errorUnsupportedLocale($target);	1✔
92	}
93
94	if ($target === $locale) {	5✔
NEW 95	CLI::error('Error: You cannot have the same values for "--target" and "--locale".', 'light_gray', 'red');	×
96
97	return EXIT_USER_INPUT;	×
98	}
99
100	if (service('environment')->isTesting()) {	5✔
101	$this->languagePath = SUPPORTPATH . 'Language';	5✔
102	}
103
104	if ($this->process($locale, $target) === EXIT_ERROR) {	5✔
105	return EXIT_ERROR;	×
106	}
107
108	CLI::write('All operations done!', 'green');	3✔
109
110	return EXIT_SUCCESS;	3✔
111	}
112
113	/**
114	* Writes the unsupported-locale error and returns the user-input exit code.
115	*/
116	private function errorUnsupportedLocale(string $locale): int
117	{
118	CLI::error(	2✔
119	sprintf(	2✔
120	'Error: "%s" is not supported. Supported locales: %s',	2✔
121	$locale,	2✔
122	implode(', ', config(App::class)->supportedLocales),	2✔
123	),	2✔
124	'light_gray',	2✔
125	'red',	2✔
126	);	2✔
127
128	return EXIT_USER_INPUT;	2✔
129	}
130
131	private function process(string $originalLocale, string $targetLocale): int
132	{
133	$originalLocaleDir = $this->languagePath . DIRECTORY_SEPARATOR . $originalLocale;	6✔
134	$targetLocaleDir = $this->languagePath . DIRECTORY_SEPARATOR . $targetLocale;	6✔
135
136	if (! is_dir($originalLocaleDir)) {	6✔
137	CLI::error(	1✔
138	sprintf('Error: The "%s" directory was not found.', clean_path($originalLocaleDir)),	1✔
139	'light_gray',	1✔
140	'red',	1✔
141	);	1✔
142
143	return EXIT_ERROR;	1✔
144	}
145
146	// Unifying the error - mkdir() may cause an exception.
147	try {
148	if (! is_dir($targetLocaleDir) && ! mkdir($targetLocaleDir, 0775)) {	6✔
149	throw new ErrorException();	5✔
150	}
151	} catch (ErrorException $e) {	1✔
152	CLI::error(	1✔
153	sprintf('Error: The target directory "%s" cannot be accessed.', clean_path($targetLocaleDir)),	1✔
154	'light_gray',	1✔
155	'red',	1✔
156	);	1✔
157
158	return EXIT_ERROR;	1✔
159	}
160
161	$iterator = new RecursiveIteratorIterator(	5✔
162	new RecursiveDirectoryIterator(	5✔
163	$originalLocaleDir,	5✔
164	FilesystemIterator::KEY_AS_PATHNAME \| FilesystemIterator::CURRENT_AS_FILEINFO \| FilesystemIterator::SKIP_DOTS,	5✔
165	),	5✔
166	);	5✔
167
168	$files = iterator_to_array($iterator);	5✔
169	ksort($files);	5✔
170
171	/** @var SplFileInfo $originalLanguageFile */
172	foreach ($files as $originalLanguageFile) {	5✔
173	if ($originalLanguageFile->getExtension() !== 'php') {	5✔
174	continue;	×
175	}
176
177	$targetLanguageFile = $targetLocaleDir . DIRECTORY_SEPARATOR . $originalLanguageFile->getFilename();	5✔
178
179	$targetLanguageKeys = [];	5✔
180	$originalLanguageKeys = include $originalLanguageFile;	5✔
181
182	if (is_file($targetLanguageFile)) {	5✔
183	$targetLanguageKeys = include $targetLanguageFile;	1✔
184	}
185
186	$targetLanguageKeys = $this->mergeLanguageKeys($originalLanguageKeys, $targetLanguageKeys, $originalLanguageFile->getBasename('.php'));	5✔
187
188	$content = "<?php\n\nreturn " . var_export($targetLanguageKeys, true) . ";\n";	5✔
189	file_put_contents($targetLanguageFile, $content);	5✔
190	}
191
192	return EXIT_SUCCESS;	3✔
193	}
194
195	/**
196	* @param array<string, array<string,mixed>\|string\|null> $originalLanguageKeys
197	* @param array<string, array<string,mixed>\|string\|null> $targetLanguageKeys
198	*
199	* @return array<string, array<string,mixed>\|string\|null>
200	*/
201	private function mergeLanguageKeys(array $originalLanguageKeys, array $targetLanguageKeys, string $prefix = ''): array
202	{
203	$mergedLanguageKeys = [];	5✔
204
205	foreach ($originalLanguageKeys as $key => $value) {	5✔
206	$placeholderValue = $prefix !== '' ? $prefix . '.' . $key : $key;	5✔
207
208	if (is_string($value)) {	5✔
209	// Keep the old value
210	// TODO: The value type may not match the original one
211	if (array_key_exists($key, $targetLanguageKeys)) {	5✔
212	$mergedLanguageKeys[$key] = $targetLanguageKeys[$key];	1✔
213
214	continue;	1✔
215	}
216
217	// Set new key with placeholder
218	$mergedLanguageKeys[$key] = $placeholderValue;	5✔
219	} elseif (is_array($value)) {	5✔
220	if (! array_key_exists($key, $targetLanguageKeys)) {	5✔
221	$mergedLanguageKeys[$key] = $this->mergeLanguageKeys($value, [], $placeholderValue);	5✔
222
223	continue;	5✔
224	}
225
226	$mergedLanguageKeys[$key] = $this->mergeLanguageKeys($value, $targetLanguageKeys[$key], $placeholderValue);	1✔
227	} else {
228	throw new LogicException(sprintf(	2✔
229	'Value for the key "%s" is of the wrong type. Only "array" or "string" is allowed.',	2✔
230	$placeholderValue,	2✔
231	));	2✔
232	}
233	}
234
235	return $mergedLanguageKeys;	5✔
236	}
237	}

codeigniter4 / CodeIgniter4 / 27466302243

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous