FileDumper.php 3.4KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  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\MessageCatalogue;
  12. use Symfony\Component\Translation\Exception\InvalidArgumentException;
  13. use Symfony\Component\Translation\Exception\RuntimeException;
  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($relativePathTemplate)
  36. {
  37. $this->relativePathTemplate = $relativePathTemplate;
  38. }
  39. /**
  40. * Sets backup flag.
  41. *
  42. * @param bool
  43. *
  44. * @deprecated since Symfony 4.1
  45. */
  46. public function setBackup($backup)
  47. {
  48. @trigger_error(sprintf('The %s() method is deprecated since Symfony 4.1.', __METHOD__), E_USER_DEPRECATED);
  49. if (false !== $backup) {
  50. throw new \LogicException('The backup feature is no longer supported.');
  51. }
  52. }
  53. /**
  54. * {@inheritdoc}
  55. */
  56. public function dump(MessageCatalogue $messages, $options = array())
  57. {
  58. if (!array_key_exists('path', $options)) {
  59. throw new InvalidArgumentException('The file dumper needs a path option.');
  60. }
  61. // save a file for each domain
  62. foreach ($messages->getDomains() as $domain) {
  63. $fullpath = $options['path'].'/'.$this->getRelativePath($domain, $messages->getLocale());
  64. if (!file_exists($fullpath)) {
  65. $directory = dirname($fullpath);
  66. if (!file_exists($directory) && !@mkdir($directory, 0777, true)) {
  67. throw new RuntimeException(sprintf('Unable to create directory "%s".', $directory));
  68. }
  69. }
  70. // save file
  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. * @param MessageCatalogue $messages
  78. * @param string $domain
  79. * @param array $options
  80. *
  81. * @return string representation
  82. */
  83. abstract public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array());
  84. /**
  85. * Gets the file extension of the dumper.
  86. *
  87. * @return string file extension
  88. */
  89. abstract protected function getExtension();
  90. /**
  91. * Gets the relative file path using the template.
  92. */
  93. private function getRelativePath(string $domain, string $locale): string
  94. {
  95. return strtr($this->relativePathTemplate, array(
  96. '%domain%' => $domain,
  97. '%locale%' => $locale,
  98. '%extension%' => $this->getExtension(),
  99. ));
  100. }
  101. }