TranslationWriter.php 2.6KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Translation\Writer;
  11. use Symfony\Component\Translation\MessageCatalogue;
  12. use Symfony\Component\Translation\Dumper\DumperInterface;
  13. use Symfony\Component\Translation\Exception\InvalidArgumentException;
  14. use Symfony\Component\Translation\Exception\RuntimeException;
  15. /**
  16. * TranslationWriter writes translation messages.
  17. *
  18. * @author Michel Salib <michelsalib@hotmail.com>
  19. */
  20. class TranslationWriter implements TranslationWriterInterface
  21. {
  22. private $dumpers = array();
  23. /**
  24. * Adds a dumper to the writer.
  25. *
  26. * @param string $format The format of the dumper
  27. * @param DumperInterface $dumper The dumper
  28. */
  29. public function addDumper($format, DumperInterface $dumper)
  30. {
  31. $this->dumpers[$format] = $dumper;
  32. }
  33. /**
  34. * Disables dumper backup.
  35. *
  36. * @deprecated since Symfony 4.1
  37. */
  38. public function disableBackup()
  39. {
  40. @trigger_error(sprintf('The %s() method is deprecated since Symfony 4.1.', __METHOD__), E_USER_DEPRECATED);
  41. foreach ($this->dumpers as $dumper) {
  42. if (method_exists($dumper, 'setBackup')) {
  43. $dumper->setBackup(false);
  44. }
  45. }
  46. }
  47. /**
  48. * Obtains the list of supported formats.
  49. *
  50. * @return array
  51. */
  52. public function getFormats()
  53. {
  54. return array_keys($this->dumpers);
  55. }
  56. /**
  57. * Writes translation from the catalogue according to the selected format.
  58. *
  59. * @param MessageCatalogue $catalogue The message catalogue to write
  60. * @param string $format The format to use to dump the messages
  61. * @param array $options Options that are passed to the dumper
  62. *
  63. * @throws InvalidArgumentException
  64. */
  65. public function write(MessageCatalogue $catalogue, $format, $options = array())
  66. {
  67. if (!isset($this->dumpers[$format])) {
  68. throw new InvalidArgumentException(sprintf('There is no dumper associated with format "%s".', $format));
  69. }
  70. // get the right dumper
  71. $dumper = $this->dumpers[$format];
  72. if (isset($options['path']) && !is_dir($options['path']) && !@mkdir($options['path'], 0777, true) && !is_dir($options['path'])) {
  73. throw new RuntimeException(sprintf('Translation Writer was not able to create directory "%s"', $options['path']));
  74. }
  75. // save
  76. $dumper->dump($catalogue, $options);
  77. }
  78. }