feature #18762 [Translation] XLIFF Add id to meta data. (SpacePossum)

fabpot · fabpot · commit 3d93a961f4aa · 2016-05-12T13:19:30.000-05:00
This PR was squashed before being merged into the 3.1-dev branch (closes #18762). Discussion ---------- [Translation] XLIFF Add `id` to meta data. | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | maybe/no | Deprecations? | no | Tests pass? | yes | License | MIT I would like to get the `id` attribute value from parsed XLIFF v1.2 files in the meta data (of the catalogue). Commits ------- ad4adca [Translation] XLIFF Add uid=501(fabien) gid=20(staff) groups=20(staff),401(com.apple.sharepoint.group.1),12(everyone),61(localaccounts),79(_appserverusr),80(admin),81(_appserveradm),98(_lpadmin),33(_appstore),100(_lpoperator),204(_developer),395(com.apple.access_ftp),398(com.apple.access_screensharing),399(com.apple.access_ssh) to meta data.
diff --git a/src/Symfony/Component/Translation/Loader/XliffFileLoader.php b/src/Symfony/Component/Translation/Loader/XliffFileLoader.php
@@ -98,13 +98,18 @@ private function extractXliff1(\DOMDocument $dom, MessageCatalogue $catalogue, $
             if ($notes = $this->parseNotesMetadata($translation->note, $encoding)) {
                 $metadata['notes'] = $notes;
             }
+
             if (isset($translation->target) && $translation->target->attributes()) {
                 $metadata['target-attributes'] = array();
                 foreach ($translation->target->attributes() as $key => $value) {
                     $metadata['target-attributes'][$key] = (string) $value;
                 }
             }
 
+            if (isset($attributes['id'])) {
+                $metadata['id'] = (string) $attributes['id'];
+            }
+
             $catalogue->setMetadata((string) $source, $metadata, $domain);
         }
     }
@@ -214,6 +219,7 @@ private function fixXmlLocation($schemaSource, $xmlUri)
                 $parts = explode('/', str_replace('\\', '/', $tmpfile));
             }
         }
+
         $drive = '\\' === DIRECTORY_SEPARATOR ? array_shift($parts).'/' : '';
         $newPath = 'file:///'.$drive.implode('/', array_map('rawurlencode', $parts));
 
@@ -280,7 +286,7 @@ private function getVersionNumber(\DOMDocument $dom)
         return '1.2';
     }
 
-    /*
+    /**
      * @param \SimpleXMLElement|null $noteElement
      * @param string|null            $encoding
      *
@@ -294,6 +300,7 @@ private function parseNotesMetadata(\SimpleXMLElement $noteElement = null, $enco
             return $notes;
         }
 
+        /** @var \SimpleXMLElement $xmlNote */
         foreach ($noteElement as $xmlNote) {
             $noteAttributes = $xmlNote->attributes();
             $note = array('content' => $this->utf8ToCharset((string) $xmlNote, $encoding));
diff --git a/src/Symfony/Component/Translation/Tests/Loader/XliffFileLoaderTest.php b/src/Symfony/Component/Translation/Tests/Loader/XliffFileLoaderTest.php
@@ -69,7 +69,7 @@ public function testEncoding()
 
         $this->assertEquals(utf8_decode('föö'), $catalogue->get('bar', 'domain1'));
         $this->assertEquals(utf8_decode('bär'), $catalogue->get('foo', 'domain1'));
-        $this->assertEquals(array('notes' => array(array('content' => utf8_decode('bäz')))), $catalogue->getMetadata('foo', 'domain1'));
+        $this->assertEquals(array('notes' => array(array('content' => utf8_decode('bäz'))), 'id' => '1'), $catalogue->getMetadata('foo', 'domain1'));
     }
 
     public function testTargetAttributesAreStoredCorrectly()
@@ -142,11 +142,11 @@ public function testLoadNotes()
         $loader = new XliffFileLoader();
         $catalogue = $loader->load(__DIR__.'/../fixtures/withnote.xlf', 'en', 'domain1');
 
-        $this->assertEquals(array('notes' => array(array('priority' => 1, 'content' => 'foo'))), $catalogue->getMetadata('foo', 'domain1'));
+        $this->assertEquals(array('notes' => array(array('priority' => 1, 'content' => 'foo')), 'id' => '1'), $catalogue->getMetadata('foo', 'domain1'));
         // message without target
-        $this->assertEquals(array('notes' => array(array('content' => 'bar', 'from' => 'foo'))), $catalogue->getMetadata('extra', 'domain1'));
+        $this->assertEquals(array('notes' => array(array('content' => 'bar', 'from' => 'foo')), 'id' => '2'), $catalogue->getMetadata('extra', 'domain1'));
         // message with empty target
-        $this->assertEquals(array('notes' => array(array('content' => 'baz'), array('priority' => 2, 'from' => 'bar', 'content' => 'qux'))), $catalogue->getMetadata('key', 'domain1'));
+        $this->assertEquals(array('notes' => array(array('content' => 'baz'), array('priority' => 2, 'from' => 'bar', 'content' => 'qux')), 'id' => '123'), $catalogue->getMetadata('key', 'domain1'));
     }
 
     public function testLoadVersion2()
diff --git a/src/Symfony/Component/Translation/Tests/fixtures/withnote.xlf b/src/Symfony/Component/Translation/Tests/fixtures/withnote.xlf
@@ -11,7 +11,7 @@
         <source>extra</source>
         <note from="foo">bar</note>
       </trans-unit>
-      <trans-unit id="3">
+      <trans-unit id="123">
         <source>key</source>
         <target></target>
         <note>baz</note>

Original file line number	Diff line number	Diff line change
`@@ -98,13 +98,18 @@ private function extractXliff1(\DOMDocument $dom, MessageCatalogue $catalogue, $`
`98`	`98`	`if ($notes = $this->parseNotesMetadata($translation->note, $encoding)) {`
`99`	`99`	`$metadata['notes'] = $notes;`
`100`	`100`	`}`
	`101`	`+`
`101`	`102`	`if (isset($translation->target) && $translation->target->attributes()) {`
`102`	`103`	`$metadata['target-attributes'] = array();`
`103`	`104`	`foreach ($translation->target->attributes() as $key => $value) {`
`104`	`105`	`$metadata['target-attributes'][$key] = (string) $value;`
`105`	`106`	`}`
`106`	`107`	`}`
`107`	`108`
	`109`	`+ if (isset($attributes['id'])) {`
	`110`	`+ $metadata['id'] = (string) $attributes['id'];`
	`111`	`+ }`
	`112`	`+`
`108`	`113`	`$catalogue->setMetadata((string) $source, $metadata, $domain);`
`109`	`114`	`}`
`110`	`115`	`}`
`@@ -214,6 +219,7 @@ private function fixXmlLocation($schemaSource, $xmlUri)`
`214`	`219`	`$parts = explode('/', str_replace('\\', '/', $tmpfile));`
`215`	`220`	`}`
`216`	`221`	`}`
	`222`	`+`
`217`	`223`	`$drive = '\\' === DIRECTORY_SEPARATOR ? array_shift($parts).'/' : '';`
`218`	`224`	`$newPath = 'file:///'.$drive.implode('/', array_map('rawurlencode', $parts));`
`219`	`225`
`@@ -280,7 +286,7 @@ private function getVersionNumber(\DOMDocument $dom)`
`280`	`286`	`return '1.2';`
`281`	`287`	`}`
`282`	`288`
`283`		`- /*`
	`289`	`+ /**`
`284`	`290`	`* @param \SimpleXMLElement\|null $noteElement`
`285`	`291`	`* @param string\|null $encoding`
`286`	`292`	`*`
`@@ -294,6 +300,7 @@ private function parseNotesMetadata(\SimpleXMLElement $noteElement = null, $enco`
`294`	`300`	`return $notes;`
`295`	`301`	`}`
`296`	`302`
	`303`	`+ /** @var \SimpleXMLElement $xmlNote */`
`297`	`304`	`foreach ($noteElement as $xmlNote) {`
`298`	`305`	`$noteAttributes = $xmlNote->attributes();`
`299`	`306`	`$note = array('content' => $this->utf8ToCharset((string) $xmlNote, $encoding));`