Merge pull request #1 from weglot/master

Add XML tag handling support

Author: arkadiusjonczek

src/DeepL.php

@@ -34,6 +34,17 @@ class DeepL
      */
     const API_URL_DESTINATION_LANG = 'target_lang=%s';
 
+    /**
+     * API v1 URL: Parameter tag_handling
+     */
+    const API_URL_TAG_HANDLING = 'tag_handling=%s';
+
+    /**
+     * API v1 URL: Parameter ignore_tags
+     */
+    const API_URL_IGNORE_TAGS = 'ignore_tags=%s';
+
+
     /**
      * DeepL HTTP error codes
      *
@@ -91,6 +102,13 @@ class DeepL
      */
     protected $curl;
 
+    /**
+     * DeepL ingored tags
+     *
+     * @var array
+     */
+    protected $ignoreTags = array();
+
     /**
      * DeepL constructor
      *
@@ -120,18 +138,19 @@ public function __destruct()
      * @param $text                string|string[]
      * @param $sourceLanguage      string
      * @param $destinationLanguage string
+     * @param $tagHandling         array
      *
      * @return string|string[]
      *
      * @throws DeepLException
      */
-    public function translate($text, $sourceLanguage = 'de', $destinationLanguage = 'en')
+    public function translate($text, $sourceLanguage = 'de', $destinationLanguage = 'en', array $tagHandling = array())
     {
         // make sure we only accept supported languages
         $this->checkLanguages($sourceLanguage, $destinationLanguage);
 
         // build the DeepL API request url
-        $url  = $this->buildUrl($sourceLanguage, $destinationLanguage);
+        $url  = $this->buildUrl($sourceLanguage, $destinationLanguage, $tagHandling);
         $body = $this->buildBody($text);
 
         // request the DeepL API
@@ -185,12 +204,20 @@ protected function checkLanguages($sourceLanguage, $destinationLanguage)
      *
      * @return string
      */
-    protected function buildUrl($sourceLanguage, $destinationLanguage)
+    protected function buildUrl($sourceLanguage, $destinationLanguage, $tagHandling = array())
     {
         $url = DeepL::API_URL . '?' . sprintf(DeepL::API_URL_AUTH_KEY, $this->authKey);
 
         $url .= '&' . sprintf(DeepL::API_URL_SOURCE_LANG, strtolower($sourceLanguage));
         $url .= '&' . sprintf(DeepL::API_URL_DESTINATION_LANG, strtolower($destinationLanguage));
+        if (!empty($tagHandling)) {
+            $url .= '&' . sprintf(DeepL::API_URL_TAG_HANDLING, implode(',', $tagHandling));
+        }
+        if (!empty($this->ignoreTags)) {
+            $url .= '&' . sprintf(DeepL::API_URL_IGNORE_TAGS, implode(',', $this->ignoreTags));
+        }
+
+
 
         return $url;
     }
@@ -259,4 +286,9 @@ protected function request($url, $body)
 
         return $translationsArray;
     }
+
+    public function setIgnoreTags(array $ignoreTags)
+    {
+        $this->ignoreTags = $ignoreTags;
+    }
 }

tests/DeepLTest.php

@@ -134,6 +134,45 @@ public function testTranslateSuccess()
         $this->assertEquals('Hello World', $translatedText);
     }
 
+    /**
+     * Test translate() with tag handling success
+     *
+     * TEST REQUIRES VALID DEEPL AUTH KEY!!
+     */
+    public function testTranslateTagHandlingSuccess()
+    {
+        return;
+
+        $authKey    = 'INSERT YOUR AUTH KEY HERE';
+        $englishText = '<strong>text to translate</strong>';
+
+        $deepl     = new DeepL($authKey);
+
+        $translatedText = $deepl->translate($germanText, 'en', 'de', array('xml'));
+
+        $this->assertEquals('<strong>Text zu übersetzen</strong>', $translatedText);
+    }
+
+    /**
+     * Test translate() with tag ignored success
+     *
+     * TEST REQUIRES VALID DEEPL AUTH KEY!!
+     */
+    public function testTranslateIgnoreTagsSuccess()
+    {
+        return;
+
+        $authKey    = 'INSERT YOUR AUTH KEY HERE';
+        $englishText = '<strong>text to do not translate</strong><p>text to translate</p>';
+
+        $deepl     = new DeepL($authKey);
+
+        $deepl->setIgnoreTags(array('strong'));
+        $translatedText = $deepl->translate($germanText, 'en', 'de', array('xml'));
+
+        $this->assertEquals('<strong>text to do not translate</strong><p>Text zu übersetzen</p>', $translatedText);
+    }
+
     /**
      * Test translate()
      *