Version for PHP 8.2 and Symfony 6.4

Author: tattali

Makefile

@@ -8,4 +8,8 @@ lint:
 	php vendor/bin/phpcs --report=code
 	php vendor/bin/phpstan analyse
 
+refactor:
+	php vendor/bin/php-cs-fixer fix
+	php vendor/bin/rector
+
 test: lint phpunit

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "tattali/mobile-detect-bundle",
-    "description": "Symfony 3.4-6.x bundle to detect mobile devices, manage mobile view and redirect to the mobile and tablet version.",
+    "description": "Symfony 6.4 bundle to detect mobile devices, manage mobile view and redirect to the mobile and tablet version.",
     "keywords": [
         "mobile detect",
         "device detect",
@@ -34,24 +34,25 @@
         }
     ],
     "require": {
-        "php": ">=7.2.5",
-        "mobiledetect/mobiledetectlib": "^2.8.15",
-        "symfony/dependency-injection": "^5.0 || ^6.0",
-        "symfony/event-dispatcher": "^5.0 || ^6.0",
-        "symfony/framework-bundle": "^5.0 || ^6.0",
-        "symfony/yaml": "^5.0 || ^6.0",
+        "php": ">=8.2",
+        "mobiledetect/mobiledetectlib": "^4.8",
+        "symfony/dependency-injection": "^6.4",
+        "symfony/event-dispatcher": "^6.4",
+        "symfony/framework-bundle": "^6.4",
+        "symfony/yaml": "^6.4",
         "twig/twig": "^2.0 || ^3.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.4 || ^3.8",
         "phpstan/extension-installer": "^1.0",
+        "phpstan/phpstan": "^1.0",
         "phpstan/phpstan-nette": "^1.0",
         "phpstan/phpstan-phpunit": "^1.0",
-        "phpstan/phpstan": "^1.0",
-        "phpunit/phpunit": "^8.5 || ^9.5",
+        "phpunit/phpunit": "^9.5",
+        "rector/rector": "^1.2",
         "squizlabs/php_codesniffer": "^3.6",
-        "symfony/dotenv": "^5.0 || ^6.0",
-        "symfony/phpunit-bridge": "^5.0 || ^6.0"
+        "symfony/dotenv": "^6.4",
+        "symfony/phpunit-bridge": "^6.4"
     },
     "config": {
         "sort-packages": true,

rector.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->withPhpSets(php82: true)
+    ->withAttributesSets(symfony: true, doctrine: true)
+    ->withSets([
+        Rector\Symfony\Set\SymfonySetList::SYMFONY_50,
+        Rector\Symfony\Set\SymfonySetList::SYMFONY_50_TYPES,
+        Rector\Symfony\Set\SymfonySetList::SYMFONY_51,
+        Rector\Symfony\Set\SymfonySetList::SYMFONY_52,
+        Rector\Symfony\Set\SymfonySetList::SYMFONY_52_VALIDATOR_ATTRIBUTES,
+        Rector\Symfony\Set\SymfonySetList::SYMFONY_53,
+        Rector\Symfony\Set\SymfonySetList::SYMFONY_60,
+        Rector\Symfony\Set\SymfonySetList::SYMFONY_61,
+        Rector\Symfony\Set\SymfonySetList::SYMFONY_62,
+        Rector\Symfony\Set\SymfonySetList::SYMFONY_63,
+        Rector\Symfony\Set\SymfonySetList::SYMFONY_64,
+        Rector\Symfony\Set\SymfonySetList::SYMFONY_CODE_QUALITY,
+        Rector\Symfony\Set\SymfonySetList::SYMFONY_CONSTRUCTOR_INJECTION,
+    ])
+    ->withDeadCodeLevel(10)
+    ->withTypeCoverageLevel(10);

src/DataCollector/DeviceDataCollector.php

@@ -45,7 +45,7 @@ public function __construct(DeviceView $deviceView)
     public function collect(
         Request $request,
         Response $response,
-        \Throwable $exception = null
+        ?\Throwable $exception = null,
     ): void {
         $this->data['currentView'] = $this->deviceView->getViewType();
         $this->data['views'] = [
@@ -127,7 +127,7 @@ protected function canUseView(string $view, ?string $host): bool
             && !empty($this->redirectConfig[$view]['host'])
             && \in_array($this->redirectConfig[$view]['action'], [RequestResponseListener::REDIRECT, RequestResponseListener::REDIRECT_WITHOUT_PATH], true)
         ) {
-            $parseHost = parse_url($this->redirectConfig[$view]['host']);
+            $parseHost = parse_url((string) $this->redirectConfig[$view]['host']);
             $redirectHost = $parseHost['scheme'].'://'.$parseHost['host'];
             if (!empty($parseHost['port'])) {
                 $redirectHost .= ':'.$parseHost['port'];
@@ -143,7 +143,7 @@ protected function canUseView(string $view, ?string $host): bool
 
     private function generateSwitchLink(
         Request $request,
-        string $view
+        string $view,
     ): ?string {
         $requestSwitchView = $request->duplicate();
         $requestSwitchView->query->set($this->deviceView->getSwitchParam(), $view);

src/DependencyInjection/MobileDetectExtension.php

@@ -15,8 +15,8 @@
 
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader;
-use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 class MobileDetectExtension extends Extension
 {

src/DeviceDetector/MobileDetector.php

@@ -13,9 +13,24 @@
 
 namespace MobileDetectBundle\DeviceDetector;
 
+use Detection\MobileDetect;
+
 /**
  * @author suncat2000 <nikolay.kotovsky@gmail.com>
  */
-class MobileDetector extends \Mobile_Detect implements MobileDetectorInterface
+class MobileDetector extends MobileDetect implements MobileDetectorInterface
 {
+    public const VERSION_TYPE_STRING = 'text';
+
+    public const VERSION_TYPE_FLOAT = 'float';
+
+    public static function getUserAgents(): array
+    {
+        return self::getBrowsers();
+    }
+
+    public function getCfHeaders(): array
+    {
+        return $this->getCloudFrontHttpHeaders();
+    }
 }

src/DeviceDetector/MobileDetectorInterface.php

@@ -196,10 +196,6 @@
  * @method bool isNetFront()
  * @method bool isGenericBrowser()
  * @method bool isPaleMoon()
- * @method bool isBot()
- * @method bool isMobileBot()
- * @method bool isDesktopMode()
- * @method bool isTV()
  * @method bool isWebKit()
  * @method bool isConsole()
  * @method bool isWatch()
@@ -211,97 +207,61 @@ interface MobileDetectorInterface
      *
      * @method bool is[...]()
      *
-     * @param string $name
-     * @param array  $arguments
-     *
      * @throws \BadMethodCallException when the method doesn't exist and doesn't start with 'is'
      */
-    public function __call($name, $arguments);
+    public function __call(string $name, array $arguments);
 
     /**
      * Retrieve the list of known browsers. Specifically, the user agents.
      *
      * @return array list of browsers / user agents
      */
-    public static function getBrowsers();
+    public static function getBrowsers(): array;
 
     /**
      * Retrieve the list of mobile operating systems.
      *
      * @return array the list of mobile operating systems
      */
-    public static function getOperatingSystems();
+    public static function getOperatingSystems(): array;
 
     /**
      * Retrieve the list of known phone devices.
      *
      * @return array list of phone devices
      */
-    public static function getPhoneDevices();
+    public static function getPhoneDevices(): array;
 
     /**
      * Get the properties array.
-     *
-     * @return array
      */
-    public static function getProperties();
-
-    /**
-     * Get the current script version.
-     * This is useful for the demo.php file,
-     * so people can check on what version they are testing
-     * for mobile devices.
-     *
-     * @return string the version number in semantic version format
-     */
-    public static function getScriptVersion();
+    public static function getProperties(): array;
 
     /**
      * Retrieve the list of known tablet devices.
      *
      * @return array list of tablet devices
      */
-    public static function getTabletDevices();
+    public static function getTabletDevices(): array;
 
     /**
      * Alias for getBrowsers() method.
      *
      * @return array list of user agents
      */
-    public static function getUserAgents();
-
-    /**
-     * Retrieve the list of known utilities.
-     *
-     * @return array list of utilities
-     */
-    public static function getUtilities();
+    public static function getUserAgents(): array;
 
     /**
      * Check the HTTP headers for signs of mobile.
      * This is the fastest mobile check possible; it's used
      * inside isMobile() method.
-     *
-     * @return bool
      */
-    public function checkHttpHeadersForMobile();
+    public function checkHttpHeadersForMobile(): bool;
 
     /**
      * Retrieves the cloudfront headers.
-     *
-     * @return array
      */
-    public function getCfHeaders();
-
-    /**
-     * Set CloudFront headers
-     * http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html#header-caching-web-device.
-     *
-     * @param array $cfHeaders List of HTTP headers
-     *
-     * @return bool If there were CloudFront headers to be set
-     */
-    public function setCfHeaders($cfHeaders = null);
+    public function getCfHeaders(): array;
 
     /**
      * Retrieves a particular header. If it doesn't exist, no exception/error is caused.
@@ -313,78 +273,67 @@ public function setCfHeaders($cfHeaders = null);
      *
      * @return string|null the value of the header
      */
-    public function getHttpHeader($header);
+    public function getHttpHeader(string $header): ?string;
 
     /**
      * Retrieves the HTTP headers.
-     *
-     * @return array
      */
-    public function getHttpHeaders();
+    public function getHttpHeaders(): array;
 
     /**
      * Set the HTTP Headers. Must be PHP-flavored. This method will reset existing headers.
      *
-     * @param array $httpHeaders The headers to set. If null, then using PHP's _SERVER to extract
-     *                           the headers. The default null is left for backwards compatibility.
+     * @param array $httpHeaders the headers to set
      */
-    public function setHttpHeaders($httpHeaders = null);
+    public function setHttpHeaders(array $httpHeaders = []): void;
 
-    public function getMatchesArray();
+    public function getMatchesArray(): ?array;
 
-    public function getMatchingRegex();
+    public function getMatchingRegex(): ?string;
 
-    public function getMobileHeaders();
+    public function getMobileHeaders(): array;
 
     /**
      * Get all possible HTTP headers that
      * can contain the User-Agent string.
      *
      * @return array list of HTTP headers
      */
-    public function getUaHttpHeaders();
+    public function getUaHttpHeaders(): array;
 
     /**
      * Retrieve the User-Agent.
      *
      * @return string|null the user agent if it's set
      */
-    public function getUserAgent();
+    public function getUserAgent(): ?string;
 
     /**
      * Set the User-Agent to be used.
      *
      * @param string $userAgent the user agent string to set
-     *
-     * @return string|null
      */
-    public function setUserAgent($userAgent = null);
+    public function setUserAgent(string $userAgent): string;
 
     /**
      * This method checks for a certain property in the
      * userAgent.
      *
-     * @param string $key
-     *
      * @return bool|int|null
      */
-    public function is($key);
+    public function is(string $key);
 
     /**
      * Check if the device is mobile.
      * Returns true if any type of mobile device detected, including special ones.
-     *
-     * @return bool
      */
-    public function isMobile();
+    public function isMobile(): bool;
 
     /**
      * Check if the device is a tablet.
      * Return true if any type of tablet device is detected.
-     *
-     * @return bool
      */
-    public function isTablet();
+    public function isTablet(): bool;
 
     /**
      * Some detection rules are relative (not standard),
@@ -394,21 +343,15 @@ public function isTablet();
      *
      * This method will be used to check custom regexes against
      * the User-Agent string.
-     *
-     * @param string $userAgent
-     *
-     * @return bool
      */
-    public function match($regex, $userAgent = null);
+    public function match(string $regex, string $userAgent): bool;
 
     /**
      * Prepare the version number.
      *
      * @param string $ver The string version, like "2.6.21.2152";
-     *
-     * @return float
      */
-    public function prepareVersionNo($ver);
+    public function prepareVersionNo(string $ver): float;
 
     /**
      * Check the version of the given property in the User-Agent.
@@ -423,5 +366,5 @@ public function prepareVersionNo($ver);
      *
      * @return string|float the version of the property we are trying to extract
      */
-    public function version($propertyName, $type = MobileDetector::VERSION_TYPE_STRING);
+    public function version(string $propertyName, string $type = MobileDetector::VERSION_TYPE_STRING): float|bool|string;
 }