metricool / vendor / _scoped / symfony / translation / Command / TranslationPushCommand.php

TranslationPushCommand.php in Metricool – Social media and site statistics 2.1.1, at vendor/_scoped/symfony/translation/Command/TranslationPushCommand.php

146 lines 7.6 KB

Raw Download Zip

1	<?php
2
3	/*
4	* This file is part of the Symfony package.
5	*
6	* (c) Fabien Potencier <[email protected]>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11	namespace Metricool\Vendor\Symfony\Component\Translation\Command;
12
13	use Metricool\Vendor\Symfony\Component\Console\Command\Command;
14	use Metricool\Vendor\Symfony\Component\Console\Completion\CompletionInput;
15	use Metricool\Vendor\Symfony\Component\Console\Completion\CompletionSuggestions;
16	use Metricool\Vendor\Symfony\Component\Console\Exception\InvalidArgumentException;
17	use Metricool\Vendor\Symfony\Component\Console\Input\InputArgument;
18	use Metricool\Vendor\Symfony\Component\Console\Input\InputInterface;
19	use Metricool\Vendor\Symfony\Component\Console\Input\InputOption;
20	use Metricool\Vendor\Symfony\Component\Console\Output\OutputInterface;
21	use Metricool\Vendor\Symfony\Component\Console\Style\SymfonyStyle;
22	use Metricool\Vendor\Symfony\Component\Translation\Provider\FilteringProvider;
23	use Metricool\Vendor\Symfony\Component\Translation\Provider\TranslationProviderCollection;
24	use Metricool\Vendor\Symfony\Component\Translation\Reader\TranslationReaderInterface;
25	use Metricool\Vendor\Symfony\Component\Translation\TranslatorBag;
26	/**
27	* @author Mathieu Santostefano <[email protected]>
28	*/
29	final class TranslationPushCommand extends Command
30	{
31	use TranslationTrait;
32	protected static $defaultName = 'translation:push';
33	protected static $defaultDescription = 'Push translations to a given provider.';
34	private $providers;
35	private $reader;
36	private $transPaths;
37	private $enabledLocales;
38	public function __construct(TranslationProviderCollection $providers, TranslationReaderInterface $reader, array $transPaths = [], array $enabledLocales = [])
39	{
40	$this->providers = $providers;
41	$this->reader = $reader;
42	$this->transPaths = $transPaths;
43	$this->enabledLocales = $enabledLocales;
44	parent::__construct();
45	}
46	public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
47	{
48	if ($input->mustSuggestArgumentValuesFor('provider')) {
49	$suggestions->suggestValues($this->providers->keys());
50	return;
51	}
52	if ($input->mustSuggestOptionValuesFor('domains')) {
53	$provider = $this->providers->get($input->getArgument('provider'));
54	if ($provider && method_exists($provider, 'getDomains')) {
55	$domains = $provider->getDomains();
56	$suggestions->suggestValues($domains);
57	}
58	return;
59	}
60	if ($input->mustSuggestOptionValuesFor('locales')) {
61	$suggestions->suggestValues($this->enabledLocales);
62	}
63	}
64	/**
65	* {@inheritdoc}
66	*/
67	protected function configure()
68	{
69	$keys = $this->providers->keys();
70	$defaultProvider = 1 === \count($keys) ? $keys[0] : null;
71	$this->setDefinition([new InputArgument('provider', null !== $defaultProvider ? InputArgument::OPTIONAL : InputArgument::REQUIRED, 'The provider to push translations to.', $defaultProvider), new InputOption('force', null, InputOption::VALUE_NONE, 'Override existing translations with local ones (it will delete not synchronized messages).'), new InputOption('delete-missing', null, InputOption::VALUE_NONE, 'Delete translations available on provider but not locally.'), new InputOption('domains', null, InputOption::VALUE_OPTIONAL \| InputOption::VALUE_IS_ARRAY, 'Specify the domains to push.'), new InputOption('locales', null, InputOption::VALUE_OPTIONAL \| InputOption::VALUE_IS_ARRAY, 'Specify the locales to push.', $this->enabledLocales)])->setHelp(<<<'EOF'
72	The <info>%command.name%</> command pushes translations to the given provider. Only new
73	translations are pushed, existing ones are not overwritten.
74
75	You can overwrite existing translations by using the <comment>--force</> flag:
76
77	<info>php %command.full_name% --force provider</>
78
79	You can delete provider translations which are not present locally by using the <comment>--delete-missing</> flag:
80
81	<info>php %command.full_name% --delete-missing provider</>
82
83	Full example:
84
85	<info>php %command.full_name% provider --force --delete-missing --domains=messages --domains=validators --locales=en</>
86
87	This command pushes all translations associated with the <comment>messages</> and <comment>validators</> domains for the <comment>en</> locale.
88	Provider translations for the specified domains and locale are deleted if they're not present locally and overwritten if it's the case.
89	Provider translations for others domains and locales are ignored.
90	EOF
91	);
92	}
93	/**
94	* {@inheritdoc}
95	*/
96	protected function execute(InputInterface $input, OutputInterface $output): int
97	{
98	$provider = $this->providers->get($input->getArgument('provider'));
99	if (!$this->enabledLocales) {
100	throw new InvalidArgumentException(sprintf('You must define "framework.translator.enabled_locales" or "framework.translator.providers.%s.locales" config key in order to work with translation providers.', parse_url($provider, \PHP_URL_SCHEME)));
101	}
102	$io = new SymfonyStyle($input, $output);
103	$domains = $input->getOption('domains');
104	$locales = $input->getOption('locales');
105	$force = $input->getOption('force');
106	$deleteMissing = $input->getOption('delete-missing');
107	if (!$domains && $provider instanceof FilteringProvider) {
108	$domains = $provider->getDomains();
109	}
110	// Reading local translations must be done after retrieving the domains from the provider
111	// in order to manage only translations from configured domains
112	$localTranslations = $this->readLocalTranslations($locales, $domains, $this->transPaths);
113	if (!$domains) {
114	$domains = $this->getDomainsFromTranslatorBag($localTranslations);
115	}
116	if (!$deleteMissing && $force) {
117	$provider->write($localTranslations);
118	$io->success(sprintf('All local translations has been sent to "%s" (for "%s" locale(s), and "%s" domain(s)).', parse_url($provider, \PHP_URL_SCHEME), implode(', ', $locales), implode(', ', $domains)));
119	return 0;
120	}
121	$providerTranslations = $provider->read($domains, $locales);
122	if ($deleteMissing) {
123	$provider->delete($providerTranslations->diff($localTranslations));
124	$io->success(sprintf('Missing translations on "%s" has been deleted (for "%s" locale(s), and "%s" domain(s)).', parse_url($provider, \PHP_URL_SCHEME), implode(', ', $locales), implode(', ', $domains)));
125	// Read provider translations again, after missing translations deletion,
126	// to avoid push freshly deleted translations.
127	$providerTranslations = $provider->read($domains, $locales);
128	}
129	$translationsToWrite = $localTranslations->diff($providerTranslations);
130	if ($force) {
131	$translationsToWrite->addBag($localTranslations->intersect($providerTranslations));
132	}
133	$provider->write($translationsToWrite);
134	$io->success(sprintf('%s local translations has been sent to "%s" (for "%s" locale(s), and "%s" domain(s)).', $force ? 'All' : 'New', parse_url($provider, \PHP_URL_SCHEME), implode(', ', $locales), implode(', ', $domains)));
135	return 0;
136	}
137	private function getDomainsFromTranslatorBag(TranslatorBag $translatorBag): array
138	{
139	$domains = [];
140	foreach ($translatorBag->getCatalogues() as $catalogue) {
141	$domains += $catalogue->getDomains();
142	}
143	return array_unique($domains);
144	}
145	}
146