Breaking-Changes:

- Remove string-return of translate()
- Add Exception when $tagHandling is send as array instead of String
- Adjust and Add Testcases

Author: VimS

src/DeepL.php

@@ -228,7 +228,7 @@ public function languages()
      * @param null            $outlineDetection
      * @param array|null      $splittingTags
      *
-     * @return mixed
+     * @return array
      * @throws DeepLException
      *
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
@@ -246,6 +246,10 @@ public function translate(
         $outlineDetection = null,
         array $splittingTags = null
     ) {
+        if (is_array($tagHandling)) {
+            throw new \InvalidArgumentException('$tagHandling must be of type String in V2 of DeepLLibrary');
+        }
+
         $paramsArray = array(
             'text'                => $text,
             'source_lang'         => $sourceLanguage,
@@ -269,13 +273,6 @@ public function translate(
 
         // request the DeepL API
         $translationsArray = $this->request($url, $body);
-        $translationsCount = count($translationsArray['translations']);
-
-        if ($translationsCount === 0) {
-            throw new DeepLException('No translations found.');
-        } elseif ($translationsCount === 1) {
-            return $translationsArray['translations'][0]['text'];
-        }
 
         return $translationsArray['translations'];
     }

tests/integration/DeepLApiTest.php

@@ -72,7 +72,7 @@ public function testTranslateSuccess()
 
         $translatedText = $deepl->translate($germanText);
 
-        $this->assertEquals($expectedText, $translatedText);
+        $this->assertEquals($expectedText, $translatedText[0]['text']);
     }
 
     /**
@@ -91,7 +91,7 @@ public function testTranslateV1Success()
 
         $translatedText = $deepl->translate($germanText);
 
-        $this->assertEquals($expectedText, $translatedText);
+        $this->assertEquals($expectedText, $translatedText[0]['text']);
     }
 
     /**
@@ -131,7 +131,7 @@ public function testTranslateTagHandlingSuccess()
             'xml'
         );
 
-        $this->assertEquals($expectedText, $translatedText);
+        $this->assertEquals($expectedText, $translatedText[0]['text']);
     }
 
     /**
@@ -156,7 +156,7 @@ public function testTranslateIgnoreTagsSuccess()
             array('strong')
         );
 
-        $this->assertEquals($expectedText, $translatedText);
+        $this->assertEquals($expectedText, $translatedText[0]['text']);
     }
 
     /**
@@ -221,7 +221,7 @@ public function testTranslateWithAllParams()
             array('p','br')                //$splittingTags
         );
 
-        $this->assertEquals($expectedText, $translatedText);
+        $this->assertEquals($expectedText, $translatedText[0]['text']);
     }
 
     /**
@@ -246,7 +246,7 @@ public function testTranslateFormality()
             'less'                         //$formality
         );
 
-        $this->assertEquals($expectedText, $translatedText);
+        $this->assertEquals($expectedText, $translatedText[0]['text']);
     }
 
     /**

tests/unit/DeepLTest.php

@@ -123,7 +123,7 @@ public function testBuildBaseUrlHost()
 
 
     /**
-     * Test buildQuery with empty Arguemtns
+     * Test buildQuery with empty Arguments
      */
     public function testBuildQueryWithNulledArguments()
     {
@@ -481,4 +481,18 @@ public function testRemoveEmptyParamsAllArgumentsAndOutlineDetectionOne()
 
         $this->assertEquals($expectation, $return);
     }
+
+    /**
+     * Test behaviour of translate() when tagHandling is an array
+     */
+    public function testTranslateExceptionTagHandling()
+    {
+        $authKey    = '123456';
+        $germanText = 'Hallo Welt';
+        $deepl      = new DeepL($authKey);
+
+        $this->setExpectedException('InvalidArgumentException');
+
+        $deepl->translate($germanText, 'de', 'en', array('xml'));
+    }
 }