Merge pull request #11 from tomschwiha/formality-patch

Add formality parameter

Author: Sascha Thielemann

src/DeepL.php

@@ -49,6 +49,11 @@ class DeepL
      */
     const API_URL_IGNORE_TAGS      = 'ignore_tags=%s';
 
+    /**
+     * API URL: Parameter formality
+     */
+    const API_URL_FORMALITY        = 'formality=%s';
+
     /**
      * DeepL HTTP error codes
      *
@@ -152,6 +157,7 @@ public function __destruct()
      * @param string          $destinationLanguage
      * @param array           $tagHandling
      * @param array           $ignoreTags
+     * @param string          $formality
      *
      * @return string|string[]
      *
@@ -162,13 +168,14 @@ public function translate(
         $sourceLanguage = 'de',
         $destinationLanguage = 'en',
         array $tagHandling = array(),
-        array $ignoreTags = array()
+        array $ignoreTags = array(),
+        $formality = "default"
     ) {
         // make sure we only accept supported languages
         $this->checkLanguages($sourceLanguage, $destinationLanguage);
 
         // build the DeepL API request url
-        $url  = $this->buildUrl($sourceLanguage, $destinationLanguage, $tagHandling, $ignoreTags);
+        $url  = $this->buildUrl($sourceLanguage, $destinationLanguage, $tagHandling, $ignoreTags, $formality);
         $body = $this->buildBody($text);
 
         // request the DeepL API
@@ -222,14 +229,16 @@ protected function checkLanguages($sourceLanguage, $destinationLanguage)
      * @param string $destinationLanguage
      * @param array  $tagHandling
      * @param array  $ignoreTags
+     * @param string $formality
      *
      * @return string
      */
     protected function buildUrl(
         $sourceLanguage,
         $destinationLanguage,
         array $tagHandling = array(),
-        array $ignoreTags = array()
+        array $ignoreTags = array(),
+        $formality = "default"
     ) {
         // select correct api url
         switch ($this->apiVersion) {
@@ -255,6 +264,10 @@ protected function buildUrl(
             $url .= '&' . sprintf(DeepL::API_URL_IGNORE_TAGS, implode(',', $ignoreTags));
         }
 
+        if (!empty($formality)) {
+            $url .= '&' . sprintf(DeepL::API_URL_FORMALITY, $formality);
+        }
+
         return $url;
     }
 

tests/DeepLTest.php

@@ -104,9 +104,15 @@ public function testCheckLanguagesDestinationLanguageException()
      */
     public function testBuildUrl()
     {
-        $expectedString = 'https://api.deepl.com/v1/translate?auth_key=123456&source_lang=de&target_lang=en';
-
         $authKey = '123456';
+
+        $expectedString = 'https://api.deepl.com/v1/translate?' . http_build_query(array(
+            'auth_key' => $authKey,
+            'source_lang' => 'de',
+            'target_lang' => 'en',
+            'formality' => 'default'
+        ));
+
         $deepl   = new DeepL($authKey);
 
         $buildUrl = self::getMethod('\BabyMarkt\DeepL\DeepL', 'buildUrl');
@@ -121,10 +127,16 @@ public function testBuildUrl()
      */
     public function testBuildUrlWithTags()
     {
-        $expectedString  = 'https://api.deepl.com';
-        $expectedString .= '/v1/translate?auth_key=123456&source_lang=de&target_lang=en&tag_handling=xml&ignore_tags=x';
-
         $authKey = '123456';
+        $expectedString = 'https://api.deepl.com/v1/translate?' . http_build_query(array(
+            'auth_key' => $authKey,
+            'source_lang' => 'de',
+            'target_lang' => 'en',
+            'tag_handling' => 'xml',
+            'ignore_tags' => 'x',
+            'formality' => 'default'
+        ));
+
         $deepl   = new DeepL($authKey);
 
         $buildUrl = self::getMethod('\BabyMarkt\DeepL\DeepL', 'buildUrl');