FileDumper.php 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  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\Dumper;
  11. use Symfony\Component\Translation\Exception\InvalidArgumentException;
  12. use Symfony\Component\Translation\Exception\RuntimeException;
  13. use Symfony\Component\Translation\MessageCatalogue;
  14. /**
  15. * FileDumper is an implementation of DumperInterface that dump a message catalogue to file(s).
  16. *
  17. * Options:
  18. * - path (mandatory): the directory where the files should be saved
  19. *
  20. * @author Michel Salib <michelsalib@hotmail.com>
  21. */
  22. abstract class FileDumper implements DumperInterface
  23. {
  24. /**
  25. * A template for the relative paths to files.
  26. *
  27. * @var string
  28. */
  29. protected $relativePathTemplate = '%domain%.%locale%.%extension%';
  30. /**
  31. * Sets the template for the relative paths to files.
  32. *
  33. * @param string $relativePathTemplate A template for the relative paths to files
  34. */
  35. public function setRelativePathTemplate(string $relativePathTemplate)
  36. {
  37. $this->relativePathTemplate = $relativePathTemplate;
  38. }
  39. /**
  40. * {@inheritdoc}
  41. */
  42. public function dump(MessageCatalogue $messages, array $options = [])
  43. {
  44. if (!\array_key_exists('path', $options)) {
  45. throw new InvalidArgumentException('The file dumper needs a path option.');
  46. }
  47. // save a file for each domain
  48. foreach ($messages->getDomains() as $domain) {
  49. $fullpath = $options['path'].'/'.$this->getRelativePath($domain, $messages->getLocale());
  50. if (!file_exists($fullpath)) {
  51. $directory = \dirname($fullpath);
  52. if (!file_exists($directory) && !@mkdir($directory, 0777, true)) {
  53. throw new RuntimeException(sprintf('Unable to create directory "%s".', $directory));
  54. }
  55. }
  56. $intlDomain = $domain.MessageCatalogue::INTL_DOMAIN_SUFFIX;
  57. $intlMessages = $messages->all($intlDomain);
  58. if ($intlMessages) {
  59. $intlPath = $options['path'].'/'.$this->getRelativePath($intlDomain, $messages->getLocale());
  60. file_put_contents($intlPath, $this->formatCatalogue($messages, $intlDomain, $options));
  61. $messages->replace([], $intlDomain);
  62. try {
  63. if ($messages->all($domain)) {
  64. file_put_contents($fullpath, $this->formatCatalogue($messages, $domain, $options));
  65. }
  66. continue;
  67. } finally {
  68. $messages->replace($intlMessages, $intlDomain);
  69. }
  70. }
  71. file_put_contents($fullpath, $this->formatCatalogue($messages, $domain, $options));
  72. }
  73. }
  74. /**
  75. * Transforms a domain of a message catalogue to its string representation.
  76. *
  77. * @return string representation
  78. */
  79. abstract public function formatCatalogue(MessageCatalogue $messages, string $domain, array $options = []);
  80. /**
  81. * Gets the file extension of the dumper.
  82. *
  83. * @return string file extension
  84. */
  85. abstract protected function getExtension();
  86. /**
  87. * Gets the relative file path using the template.
  88. */
  89. private function getRelativePath(string $domain, string $locale): string
  90. {
  91. return strtr($this->relativePathTemplate, [
  92. '%domain%' => $domain,
  93. '%locale%' => $locale,
  94. '%extension%' => $this->getExtension(),
  95. ]);
  96. }
  97. }