Create an interface for TranslationWriter
This commit is contained in:
parent
266d9d375e
commit
c25eafa4f3
@ -128,6 +128,13 @@ SecurityBundle
|
|||||||
|
|
||||||
* `FirewallContext::getListeners()` now returns `\Traversable|array`
|
* `FirewallContext::getListeners()` now returns `\Traversable|array`
|
||||||
|
|
||||||
|
Translation
|
||||||
|
-----------
|
||||||
|
|
||||||
|
* `Symfony\Component\Translation\Writer\TranslationWriter::writeTranslations` has been deprecated
|
||||||
|
and will be removed in 4.0, use `Symfony\Component\Translation\Writer\TranslationWriter::write`
|
||||||
|
instead.
|
||||||
|
|
||||||
TwigBridge
|
TwigBridge
|
||||||
----------
|
----------
|
||||||
|
|
||||||
|
@ -554,6 +554,9 @@ Translation
|
|||||||
-----------
|
-----------
|
||||||
|
|
||||||
* Removed the backup feature from the file dumper classes.
|
* Removed the backup feature from the file dumper classes.
|
||||||
|
|
||||||
|
* Removed `Symfony\Component\Translation\Writer\TranslationWriter::writeTranslations`,
|
||||||
|
use `Symfony\Component\Translation\Writer\TranslationWriter::write` instead.
|
||||||
|
|
||||||
TwigBundle
|
TwigBundle
|
||||||
----------
|
----------
|
||||||
|
@ -21,7 +21,7 @@ use Symfony\Component\Console\Input\InputArgument;
|
|||||||
use Symfony\Component\Console\Input\InputOption;
|
use Symfony\Component\Console\Input\InputOption;
|
||||||
use Symfony\Component\Translation\Extractor\ExtractorInterface;
|
use Symfony\Component\Translation\Extractor\ExtractorInterface;
|
||||||
use Symfony\Component\Translation\MessageCatalogue;
|
use Symfony\Component\Translation\MessageCatalogue;
|
||||||
use Symfony\Component\Translation\Writer\TranslationWriter;
|
use Symfony\Component\Translation\Writer\TranslationWriterInterface;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A command that parses templates to extract translation messages and adds them
|
* A command that parses templates to extract translation messages and adds them
|
||||||
@ -39,14 +39,14 @@ class TranslationUpdateCommand extends ContainerAwareCommand
|
|||||||
private $defaultLocale;
|
private $defaultLocale;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param TranslationWriter $writer
|
* @param TranslationWriterInterface $writer
|
||||||
* @param TranslationLoader $loader
|
* @param TranslationLoader $loader
|
||||||
* @param ExtractorInterface $extractor
|
* @param ExtractorInterface $extractor
|
||||||
* @param string $defaultLocale
|
* @param string $defaultLocale
|
||||||
*/
|
*/
|
||||||
public function __construct($writer = null, TranslationLoader $loader = null, ExtractorInterface $extractor = null, $defaultLocale = null)
|
public function __construct($writer = null, TranslationLoader $loader = null, ExtractorInterface $extractor = null, $defaultLocale = null)
|
||||||
{
|
{
|
||||||
if (!$writer instanceof TranslationWriter) {
|
if (!$writer instanceof TranslationWriterInterface) {
|
||||||
@trigger_error(sprintf('Passing a command name as the first argument of "%s" is deprecated since version 3.4 and will be removed in 4.0. If the command was registered by convention, make it a service instead.', __METHOD__), E_USER_DEPRECATED);
|
@trigger_error(sprintf('Passing a command name as the first argument of "%s" is deprecated since version 3.4 and will be removed in 4.0. If the command was registered by convention, make it a service instead.', __METHOD__), E_USER_DEPRECATED);
|
||||||
|
|
||||||
parent::__construct($writer);
|
parent::__construct($writer);
|
||||||
@ -276,7 +276,7 @@ EOF
|
|||||||
$bundleTransPath = end($transPaths).'translations';
|
$bundleTransPath = end($transPaths).'translations';
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->writer->writeTranslations($operation->getResult(), $input->getOption('output-format'), array('path' => $bundleTransPath, 'default_locale' => $this->defaultLocale));
|
$this->writer->write($operation->getResult(), $input->getOption('output-format'), array('path' => $bundleTransPath, 'default_locale' => $this->defaultLocale));
|
||||||
|
|
||||||
if (true === $input->getOption('dump-messages')) {
|
if (true === $input->getOption('dump-messages')) {
|
||||||
$resultMessage .= ' and translation files were updated';
|
$resultMessage .= ' and translation files were updated';
|
||||||
|
@ -7,6 +7,8 @@ CHANGELOG
|
|||||||
* Added `TranslationDumperPass`
|
* Added `TranslationDumperPass`
|
||||||
* Added `TranslationExtractorPass`
|
* Added `TranslationExtractorPass`
|
||||||
* Added `TranslatorPass`
|
* Added `TranslatorPass`
|
||||||
|
* Added `TranslationWriterInterface`
|
||||||
|
* Deprecated `TranslationWriter::writeTranslations` in favor of `TranslationWriter::write`
|
||||||
|
|
||||||
3.2.0
|
3.2.0
|
||||||
-----
|
-----
|
||||||
|
@ -18,6 +18,10 @@ use Symfony\Component\Translation\Writer\TranslationWriter;
|
|||||||
|
|
||||||
class TranslationWriterTest extends TestCase
|
class TranslationWriterTest extends TestCase
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* @group legacy
|
||||||
|
* @expectedDeprecation Method Symfony\Component\Translation\Writer\TranslationWriter::writeTranslations() is deprecated since version 3.4 and will be removed in 4.0. Use write() instead.
|
||||||
|
*/
|
||||||
public function testWriteTranslations()
|
public function testWriteTranslations()
|
||||||
{
|
{
|
||||||
$dumper = $this->getMockBuilder('Symfony\Component\Translation\Dumper\DumperInterface')->getMock();
|
$dumper = $this->getMockBuilder('Symfony\Component\Translation\Dumper\DumperInterface')->getMock();
|
||||||
@ -30,6 +34,18 @@ class TranslationWriterTest extends TestCase
|
|||||||
$writer->writeTranslations(new MessageCatalogue(array()), 'test');
|
$writer->writeTranslations(new MessageCatalogue(array()), 'test');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function testWrite()
|
||||||
|
{
|
||||||
|
$dumper = $this->getMockBuilder('Symfony\Component\Translation\Dumper\DumperInterface')->getMock();
|
||||||
|
$dumper
|
||||||
|
->expects($this->once())
|
||||||
|
->method('dump');
|
||||||
|
|
||||||
|
$writer = new TranslationWriter();
|
||||||
|
$writer->addDumper('test', $dumper);
|
||||||
|
$writer->write(new MessageCatalogue(array()), 'test');
|
||||||
|
}
|
||||||
|
|
||||||
public function testDisableBackup()
|
public function testDisableBackup()
|
||||||
{
|
{
|
||||||
$nonBackupDumper = new NonBackupDumper();
|
$nonBackupDumper = new NonBackupDumper();
|
||||||
|
@ -21,7 +21,7 @@ use Symfony\Component\Translation\Exception\RuntimeException;
|
|||||||
*
|
*
|
||||||
* @author Michel Salib <michelsalib@hotmail.com>
|
* @author Michel Salib <michelsalib@hotmail.com>
|
||||||
*/
|
*/
|
||||||
class TranslationWriter
|
class TranslationWriter implements TranslationWriterInterface
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Dumpers used for export.
|
* Dumpers used for export.
|
||||||
@ -66,13 +66,13 @@ class TranslationWriter
|
|||||||
/**
|
/**
|
||||||
* Writes translation from the catalogue according to the selected format.
|
* Writes translation from the catalogue according to the selected format.
|
||||||
*
|
*
|
||||||
* @param MessageCatalogue $catalogue The message catalogue to dump
|
* @param MessageCatalogue $catalogue The message catalogue to write
|
||||||
* @param string $format The format to use to dump the messages
|
* @param string $format The format to use to dump the messages
|
||||||
* @param array $options Options that are passed to the dumper
|
* @param array $options Options that are passed to the dumper
|
||||||
*
|
*
|
||||||
* @throws InvalidArgumentException
|
* @throws InvalidArgumentException
|
||||||
*/
|
*/
|
||||||
public function writeTranslations(MessageCatalogue $catalogue, $format, $options = array())
|
public function write(MessageCatalogue $catalogue, $format, $options = array())
|
||||||
{
|
{
|
||||||
if (!isset($this->dumpers[$format])) {
|
if (!isset($this->dumpers[$format])) {
|
||||||
throw new InvalidArgumentException(sprintf('There is no dumper associated with format "%s".', $format));
|
throw new InvalidArgumentException(sprintf('There is no dumper associated with format "%s".', $format));
|
||||||
@ -88,4 +88,21 @@ class TranslationWriter
|
|||||||
// save
|
// save
|
||||||
$dumper->dump($catalogue, $options);
|
$dumper->dump($catalogue, $options);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Writes translation from the catalogue according to the selected format.
|
||||||
|
*
|
||||||
|
* @param MessageCatalogue $catalogue The message catalogue to write
|
||||||
|
* @param string $format The format to use to dump the messages
|
||||||
|
* @param array $options Options that are passed to the dumper
|
||||||
|
*
|
||||||
|
* @throws InvalidArgumentException
|
||||||
|
*
|
||||||
|
* @deprecated since 3.4 will be removed in 4.0. Use write instead.
|
||||||
|
*/
|
||||||
|
public function writeTranslations(MessageCatalogue $catalogue, $format, $options = array())
|
||||||
|
{
|
||||||
|
@trigger_error(sprintf('Method %s() is deprecated since version 3.4 and will be removed in 4.0. Use write() instead.', __METHOD__), E_USER_DEPRECATED);
|
||||||
|
$this->write($catalogue, $format, $options);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -0,0 +1,34 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This file is part of the Symfony package.
|
||||||
|
*
|
||||||
|
* (c) Fabien Potencier <fabien@symfony.com>
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view the LICENSE
|
||||||
|
* file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Symfony\Component\Translation\Writer;
|
||||||
|
|
||||||
|
use Symfony\Component\Translation\Exception\InvalidArgumentException;
|
||||||
|
use Symfony\Component\Translation\MessageCatalogue;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TranslationWriter writes translation messages.
|
||||||
|
*
|
||||||
|
* @author Michel Salib <michelsalib@hotmail.com>
|
||||||
|
*/
|
||||||
|
interface TranslationWriterInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Writes translation from the catalogue according to the selected format.
|
||||||
|
*
|
||||||
|
* @param MessageCatalogue $catalogue The message catalogue to write
|
||||||
|
* @param string $format The format to use to dump the messages
|
||||||
|
* @param array $options Options that are passed to the dumper
|
||||||
|
*
|
||||||
|
* @throws InvalidArgumentException
|
||||||
|
*/
|
||||||
|
public function write(MessageCatalogue $catalogue, $format, $options = array());
|
||||||
|
}
|
Reference in New Issue
Block a user