annotate vendor/symfony/translation/Dumper/XliffFileDumper.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Translation\Dumper;
Chris@0 13
Chris@17 14 use Symfony\Component\Translation\Exception\InvalidArgumentException;
Chris@0 15 use Symfony\Component\Translation\MessageCatalogue;
Chris@0 16
Chris@0 17 /**
Chris@0 18 * XliffFileDumper generates xliff files from a message catalogue.
Chris@0 19 *
Chris@0 20 * @author Michel Salib <michelsalib@hotmail.com>
Chris@0 21 */
Chris@0 22 class XliffFileDumper extends FileDumper
Chris@0 23 {
Chris@0 24 /**
Chris@0 25 * {@inheritdoc}
Chris@0 26 */
Chris@17 27 public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = [])
Chris@0 28 {
Chris@0 29 $xliffVersion = '1.2';
Chris@18 30 if (\array_key_exists('xliff_version', $options)) {
Chris@0 31 $xliffVersion = $options['xliff_version'];
Chris@0 32 }
Chris@0 33
Chris@18 34 if (\array_key_exists('default_locale', $options)) {
Chris@0 35 $defaultLocale = $options['default_locale'];
Chris@0 36 } else {
Chris@0 37 $defaultLocale = \Locale::getDefault();
Chris@0 38 }
Chris@0 39
Chris@0 40 if ('1.2' === $xliffVersion) {
Chris@0 41 return $this->dumpXliff1($defaultLocale, $messages, $domain, $options);
Chris@0 42 }
Chris@0 43 if ('2.0' === $xliffVersion) {
Chris@0 44 return $this->dumpXliff2($defaultLocale, $messages, $domain, $options);
Chris@0 45 }
Chris@0 46
Chris@0 47 throw new InvalidArgumentException(sprintf('No support implemented for dumping XLIFF version "%s".', $xliffVersion));
Chris@0 48 }
Chris@0 49
Chris@0 50 /**
Chris@0 51 * {@inheritdoc}
Chris@0 52 */
Chris@0 53 protected function getExtension()
Chris@0 54 {
Chris@0 55 return 'xlf';
Chris@0 56 }
Chris@0 57
Chris@17 58 private function dumpXliff1($defaultLocale, MessageCatalogue $messages, $domain, array $options = [])
Chris@0 59 {
Chris@17 60 $toolInfo = ['tool-id' => 'symfony', 'tool-name' => 'Symfony'];
Chris@18 61 if (\array_key_exists('tool_info', $options)) {
Chris@0 62 $toolInfo = array_merge($toolInfo, $options['tool_info']);
Chris@0 63 }
Chris@0 64
Chris@0 65 $dom = new \DOMDocument('1.0', 'utf-8');
Chris@0 66 $dom->formatOutput = true;
Chris@0 67
Chris@0 68 $xliff = $dom->appendChild($dom->createElement('xliff'));
Chris@0 69 $xliff->setAttribute('version', '1.2');
Chris@0 70 $xliff->setAttribute('xmlns', 'urn:oasis:names:tc:xliff:document:1.2');
Chris@0 71
Chris@0 72 $xliffFile = $xliff->appendChild($dom->createElement('file'));
Chris@0 73 $xliffFile->setAttribute('source-language', str_replace('_', '-', $defaultLocale));
Chris@0 74 $xliffFile->setAttribute('target-language', str_replace('_', '-', $messages->getLocale()));
Chris@0 75 $xliffFile->setAttribute('datatype', 'plaintext');
Chris@0 76 $xliffFile->setAttribute('original', 'file.ext');
Chris@0 77
Chris@0 78 $xliffHead = $xliffFile->appendChild($dom->createElement('header'));
Chris@0 79 $xliffTool = $xliffHead->appendChild($dom->createElement('tool'));
Chris@0 80 foreach ($toolInfo as $id => $value) {
Chris@0 81 $xliffTool->setAttribute($id, $value);
Chris@0 82 }
Chris@0 83
Chris@0 84 $xliffBody = $xliffFile->appendChild($dom->createElement('body'));
Chris@0 85 foreach ($messages->all($domain) as $source => $target) {
Chris@0 86 $translation = $dom->createElement('trans-unit');
Chris@0 87
Chris@14 88 $translation->setAttribute('id', strtr(substr(base64_encode(hash('sha256', $source, true)), 0, 7), '/+', '._'));
Chris@0 89 $translation->setAttribute('resname', $source);
Chris@0 90
Chris@0 91 $s = $translation->appendChild($dom->createElement('source'));
Chris@0 92 $s->appendChild($dom->createTextNode($source));
Chris@0 93
Chris@0 94 // Does the target contain characters requiring a CDATA section?
Chris@0 95 $text = 1 === preg_match('/[&<>]/', $target) ? $dom->createCDATASection($target) : $dom->createTextNode($target);
Chris@0 96
Chris@0 97 $targetElement = $dom->createElement('target');
Chris@0 98 $metadata = $messages->getMetadata($source, $domain);
Chris@0 99 if ($this->hasMetadataArrayInfo('target-attributes', $metadata)) {
Chris@0 100 foreach ($metadata['target-attributes'] as $name => $value) {
Chris@0 101 $targetElement->setAttribute($name, $value);
Chris@0 102 }
Chris@0 103 }
Chris@0 104 $t = $translation->appendChild($targetElement);
Chris@0 105 $t->appendChild($text);
Chris@0 106
Chris@0 107 if ($this->hasMetadataArrayInfo('notes', $metadata)) {
Chris@0 108 foreach ($metadata['notes'] as $note) {
Chris@0 109 if (!isset($note['content'])) {
Chris@0 110 continue;
Chris@0 111 }
Chris@0 112
Chris@0 113 $n = $translation->appendChild($dom->createElement('note'));
Chris@0 114 $n->appendChild($dom->createTextNode($note['content']));
Chris@0 115
Chris@0 116 if (isset($note['priority'])) {
Chris@0 117 $n->setAttribute('priority', $note['priority']);
Chris@0 118 }
Chris@0 119
Chris@0 120 if (isset($note['from'])) {
Chris@0 121 $n->setAttribute('from', $note['from']);
Chris@0 122 }
Chris@0 123 }
Chris@0 124 }
Chris@0 125
Chris@0 126 $xliffBody->appendChild($translation);
Chris@0 127 }
Chris@0 128
Chris@0 129 return $dom->saveXML();
Chris@0 130 }
Chris@0 131
Chris@17 132 private function dumpXliff2($defaultLocale, MessageCatalogue $messages, $domain, array $options = [])
Chris@0 133 {
Chris@0 134 $dom = new \DOMDocument('1.0', 'utf-8');
Chris@0 135 $dom->formatOutput = true;
Chris@0 136
Chris@0 137 $xliff = $dom->appendChild($dom->createElement('xliff'));
Chris@0 138 $xliff->setAttribute('xmlns', 'urn:oasis:names:tc:xliff:document:2.0');
Chris@0 139 $xliff->setAttribute('version', '2.0');
Chris@0 140 $xliff->setAttribute('srcLang', str_replace('_', '-', $defaultLocale));
Chris@0 141 $xliff->setAttribute('trgLang', str_replace('_', '-', $messages->getLocale()));
Chris@0 142
Chris@0 143 $xliffFile = $xliff->appendChild($dom->createElement('file'));
Chris@0 144 $xliffFile->setAttribute('id', $domain.'.'.$messages->getLocale());
Chris@0 145
Chris@0 146 foreach ($messages->all($domain) as $source => $target) {
Chris@0 147 $translation = $dom->createElement('unit');
Chris@14 148 $translation->setAttribute('id', strtr(substr(base64_encode(hash('sha256', $source, true)), 0, 7), '/+', '._'));
Chris@14 149 $metadata = $messages->getMetadata($source, $domain);
Chris@14 150
Chris@14 151 // Add notes section
Chris@14 152 if ($this->hasMetadataArrayInfo('notes', $metadata)) {
Chris@14 153 $notesElement = $dom->createElement('notes');
Chris@14 154 foreach ($metadata['notes'] as $note) {
Chris@14 155 $n = $dom->createElement('note');
Chris@14 156 $n->appendChild($dom->createTextNode(isset($note['content']) ? $note['content'] : ''));
Chris@14 157 unset($note['content']);
Chris@14 158
Chris@14 159 foreach ($note as $name => $value) {
Chris@14 160 $n->setAttribute($name, $value);
Chris@14 161 }
Chris@14 162 $notesElement->appendChild($n);
Chris@14 163 }
Chris@14 164 $translation->appendChild($notesElement);
Chris@14 165 }
Chris@0 166
Chris@0 167 $segment = $translation->appendChild($dom->createElement('segment'));
Chris@0 168
Chris@0 169 $s = $segment->appendChild($dom->createElement('source'));
Chris@0 170 $s->appendChild($dom->createTextNode($source));
Chris@0 171
Chris@0 172 // Does the target contain characters requiring a CDATA section?
Chris@0 173 $text = 1 === preg_match('/[&<>]/', $target) ? $dom->createCDATASection($target) : $dom->createTextNode($target);
Chris@0 174
Chris@0 175 $targetElement = $dom->createElement('target');
Chris@0 176 if ($this->hasMetadataArrayInfo('target-attributes', $metadata)) {
Chris@0 177 foreach ($metadata['target-attributes'] as $name => $value) {
Chris@0 178 $targetElement->setAttribute($name, $value);
Chris@0 179 }
Chris@0 180 }
Chris@0 181 $t = $segment->appendChild($targetElement);
Chris@0 182 $t->appendChild($text);
Chris@0 183
Chris@0 184 $xliffFile->appendChild($translation);
Chris@0 185 }
Chris@0 186
Chris@0 187 return $dom->saveXML();
Chris@0 188 }
Chris@0 189
Chris@0 190 /**
Chris@0 191 * @param string $key
Chris@0 192 * @param array|null $metadata
Chris@0 193 *
Chris@0 194 * @return bool
Chris@0 195 */
Chris@0 196 private function hasMetadataArrayInfo($key, $metadata = null)
Chris@0 197 {
Chris@18 198 return null !== $metadata && \array_key_exists($key, $metadata) && ($metadata[$key] instanceof \Traversable || \is_array($metadata[$key]));
Chris@0 199 }
Chris@0 200 }