Add deprecations

Author: laurynas

CHANGELOG.md

@@ -13,7 +13,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 - Switched to v3 API which uses updated language detection model
-- ⚠️ `simpleDetect` method renamed to `detectCode`
 - ⚠️ `detect` method result fields are `language` and `score`
-- ⚠️ `detect` method no longer accept arrays - use `detectBatch` instead
-- HTTPS is used by default. Removed secure mode configuration.
+- ⚠️ `simpleDetect` deprecated, use `detectCode` instead
+- ⚠️ `detect` for batch detection is deprecated, use `detectBatch` instead
+
+### Removed
+- Secure mode configuration. HTTPS is always used.

composer.json

@@ -15,7 +15,7 @@
         "php": ">=5.3.0"
     },
     "require-dev": {
-        "yoast/phpunit-polyfills": "^1.0"
+        "phpunit/phpunit": "^12.2"
     },
     "config": {
         "bin-dir": "bin"
@@ -24,5 +24,8 @@
         "psr-0": {
             "DetectLanguage": "lib/"
         }
+    },
+    "scripts": {
+        "test": "php -d memory_limit=512M vendor/phpunit/phpunit/phpunit"
     }
 }

lib/DetectLanguage/DetectLanguage.php

@@ -59,7 +59,8 @@ public static function setApiKey($apiKey)
     public static function detect($text)
     {
         if (is_array($text)) {
-            throw new Error('detect method does not accept arrays, use detectBatch instead');
+            trigger_error('detect method does not accept arrays, use detectBatch instead', E_USER_DEPRECATED);
+            return self::detectBatch($text);
         }
 
         return Client::request('POST', 'detect', array('q' => $text));
@@ -115,4 +116,17 @@ public static function getLanguages()
     {
         return Client::request('GET', 'languages');
     }
+
+    // DEPRECATED METHODS
+
+    /**
+     * @deprecated use self::detectCode instead
+     * @param string $text The text for language detection
+     * @return string|null detected language code
+     */
+    public static function simpleDetect($text)
+    {
+        trigger_error('simpleDetect method is deprecated, use detectCode instead', E_USER_DEPRECATED);
+        return self::detectCode($text);
+    }
 }

phpunit.xml.dist

@@ -1,10 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="vendor/autoload.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-  <coverage>
-    <include>
-      <directory suffix=".php">./lib/DetectLanguage/</directory>
-    </include>
-  </coverage>
+<phpunit
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  backupGlobals="false"
+  bootstrap="vendor/autoload.php"
+  colors="true"
+  xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/12.0/phpunit.xsd"
+  executionOrder="random"
+  displayDetailsOnPhpunitDeprecations="true"
+>
   <testsuites>
     <testsuite name="DetectLanguage Test Suite">
       <directory suffix="Test.php">./tests/DetectLanguage/</directory>

tests/DetectLanguage/DetectLanguageTest.php

@@ -3,13 +3,13 @@
 namespace DetectLanguage\Test;
 
 use \DetectLanguage\DetectLanguage;
-use \Yoast\PHPUnitPolyfills\TestCases\TestCase;
+use PHPUnit\Framework\TestCase;
 
 class DetectLanguageTest extends TestCase
 {
-    public function set_up()
+    protected function setUp(): void
     {
-        parent::set_up();
+        parent::setUp();
 
         DetectLanguage::$apiKey = getenv('DETECTLANGUAGE_API_KEY');
     }
@@ -38,8 +38,12 @@ public function testDetect()
 
     public function testDetectWithArray()
     {
-        $this->expectException('\DetectLanguage\Error');
+        $this->expectUserDeprecationMessage('detect method does not accept arrays, use detectBatch instead');
+
         $result = DetectLanguage::detect(array('Hello world'));
+
+        $this->assertEquals('en', $result[0][0]->language,
+            'To detect English language.');
     }
 
     public function testDetectCode()
@@ -50,6 +54,14 @@ public function testDetectCode()
             'To detect English language.');
     }
 
+    public function testSimpleDetect()
+    {
+        $this->expectUserDeprecationMessage('simpleDetect method is deprecated, use detectCode instead');
+        $result = DetectLanguage::simpleDetect('Hello world');
+        $this->assertEquals('en', $result,
+            'To detect English language.');
+    }
+
     public function testCurlRequest()
     {
         $this->setRequestEngine('curl');