feat: drop support for PHP < 8.0

drop support for twig < 2.15.6 bump min versions add PHP strong types
debesha · Jun 21, 2024 · f6da29a · f6da29a
1 parent f148ec4
commit f6da29a
Show file tree

Hide file tree

Showing 9 changed files with 54 additions and 125 deletions.
diff --git a/DataCollector/HydrationDataCollector.php b/DataCollector/HydrationDataCollector.php
@@ -21,20 +21,14 @@
 
 class HydrationDataCollector extends DataCollector
 {
-    /**
-     * @var HydrationLogger
-     */
-    private $hydrationLogger;
+    private HydrationLogger $hydrationLogger;
 
     public function __construct(EntityManagerInterface $manager)
     {
         $this->hydrationLogger = $manager->getConfiguration()->getHydrationLogger();
     }
 
-    /**
-     * @return void
-     */
-    public function collect(Request $request, Response $response, \Throwable $exception = null)
+    public function collect(Request $request, Response $response, \Throwable $exception = null): void
     {
         $this->data['hydrations'] = $this->hydrationLogger->hydrations;
     }
@@ -44,12 +38,12 @@ public function getHydrations()
         return $this->data['hydrations'];
     }
 
-    public function getHydrationsCount()
+    public function getHydrationsCount(): int
     {
         return count($this->data['hydrations']);
     }
 
-    public function getTime()
+    public function getTime(): int
     {
         $time = 0;
         foreach ($this->data['hydrations'] as $hydration) {
@@ -61,18 +55,12 @@ public function getTime()
         return $time;
     }
 
-    /**
-     * @return string
-     */
-    public function getName()
+    public function getName(): string
     {
         return 'hydrations';
     }
 
-    /**
-     * @return void
-     */
-    public function reset()
+    public function reset(): void
     {
         $this->data = [];
         $this->hydrationLogger->hydrations = [];

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -12,15 +12,8 @@
  */
 class Configuration implements ConfigurationInterface
 {
-    /**
-     * @return TreeBuilder
-     */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
-        // Here you should define the parameters that are allowed to
-        // configure your bundle. See the documentation linked above for
-        // more information on that topic.
-
         return new TreeBuilder('debesha_doctrine_profile_extra');
     }
 }
diff --git a/DependencyInjection/DebeshaDoctrineProfileExtraExtension.php b/DependencyInjection/DebeshaDoctrineProfileExtraExtension.php
@@ -14,10 +14,7 @@
  */
 class DebeshaDoctrineProfileExtraExtension extends Extension
 {
-    /**
-     * @return void
-     */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         if (!$container->hasParameter('doctrine.orm.entity_manager.class')) {
             throw new \InvalidArgumentException('You must include DoctrineBundle/DoctrineBundle before DebeshaDoctrineProfileExtraBundle in your AppKerner.php');

diff --git a/ORM/HydrationLogger.php b/ORM/HydrationLogger.php
@@ -19,34 +19,24 @@ class HydrationLogger
 {
     /**
      * Executed hydrations
-     *
-     * @var array
      */
-    public $hydrations = [];
+    public array $hydrations = [];
 
     /**
      * If Debug Stack is enabled (log queries) or not.
-     *
-     * @var bool
      */
-    public $enabled = true;
+    public bool $enabled = true;
 
-    /**
-     * @var float|null
-     */
-    public $start = null;
+    public ?float $start = null;
 
-    /**
-     * @var int
-     */
-    public $currentHydration = 0;
+    public int $currentHydration = 0;
 
     /**
      * Marks a hydration as started. Timing is started
      *
      * @param string $type type of hydration
      */
-    public function start($type)
+    public function start(string $type): void
     {
         if ($this->enabled) {
             $this->start = microtime(true);
@@ -58,13 +48,8 @@ public function start($type)
     /**
      * Marks a hydration as stopped. Number of hydrated entities and alias map is
      * passed to method.
-     *
-     * @param int $resultNum
-     * @param array $aliasMap
-     *
-     * @return void
      */
-    public function stop($resultNum, $aliasMap)
+    public function stop(int $resultNum, array $aliasMap): void
     {
         if ($this->enabled) {
             $this->hydrations[$this->currentHydration]['executionMS'] = microtime(true) - $this->start;

diff --git a/ORM/LoggingConfiguration.php b/ORM/LoggingConfiguration.php
@@ -17,26 +17,13 @@ public function __construct()
         $hydrationLogger = new HydrationLogger();
         $this->setHydrationLogger($hydrationLogger);
     }
-    /**
-     * Gets the hydration logger.
-     *
-     * @return HydrationLogger|null
-     */
-    public function getHydrationLogger()
+
+    public function getHydrationLogger(): ?HydrationLogger
     {
-        return isset($this->_attributes['hydrationLogger'])
-            ? $this->_attributes['hydrationLogger']
-            : null;
+        return $this->_attributes['hydrationLogger'] ?? null;
     }
 
-    /**
-     * Sets the hydration logger.
-     *
-     * @param HydrationLogger $ns
-     *
-     * @return void
-     */
-    public function setHydrationLogger(HydrationLogger $logger)
+    public function setHydrationLogger(HydrationLogger $logger): void
     {
         $this->_attributes['hydrationLogger'] = $logger;
     }

diff --git a/ORM/LoggingEntityManager.php b/ORM/LoggingEntityManager.php
@@ -17,10 +17,11 @@
 namespace Debesha\DoctrineProfileExtraBundle\ORM;
 
 use Doctrine\Common\EventManager;
+use Doctrine\DBAL\Exception;
+use Doctrine\ORM\AbstractQuery;
 use Doctrine\ORM\Configuration;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\ORMException;
-use Doctrine\ORM\Query;
 use Doctrine\DBAL\Connection;
 use Doctrine\ORM\Internal\Hydration\AbstractHydrator;
 
@@ -31,52 +32,36 @@ class LoggingEntityManager extends EntityManager
      */
     public function newHydrator($hydrationMode): AbstractHydrator
     {
-        switch ($hydrationMode) {
-            case Query::HYDRATE_OBJECT:
-                return new LoggingObjectHydrator($this);
-
-            case Query::HYDRATE_ARRAY:
-                return new LoggingArrayHydrator($this);
-
-            case Query::HYDRATE_SCALAR:
-                return new LoggingScalarHydrator($this);
-
-            case Query::HYDRATE_SINGLE_SCALAR:
-                return new LoggingSingleScalarHydrator($this);
-
-            case Query::HYDRATE_SIMPLEOBJECT:
-                return new LoggingSimpleObjectHydrator($this);
-            default:
-                return parent::newHydrator($hydrationMode);
-        }
-    }
-
-    /**
-     * @return Configuration
-     */
-    public function getConfiguration()
-    {
-        return parent::getConfiguration();
+        return match ($hydrationMode) {
+            AbstractQuery::HYDRATE_OBJECT => new LoggingObjectHydrator($this),
+            AbstractQuery::HYDRATE_ARRAY => new LoggingArrayHydrator($this),
+            AbstractQuery::HYDRATE_SCALAR => new LoggingScalarHydrator($this),
+            AbstractQuery::HYDRATE_SINGLE_SCALAR => new LoggingSingleScalarHydrator($this),
+            AbstractQuery::HYDRATE_SIMPLEOBJECT => new LoggingSimpleObjectHydrator($this),
+            default => parent::newHydrator($hydrationMode),
+        };
     }
 
     /**
      * {@inheritdoc}
+     *
+     * @throws Exception|ORMException
      */
-    public static function create($conn, Configuration $config, EventManager $eventManager = null): EntityManager
+    public static function create($connection, Configuration $config, EventManager $eventManager = null): EntityManager
     {
         if (!$config->getMetadataDriverImpl()) {
             throw ORMException::missingMappingDriverImpl();
         }
 
         switch (true) {
-            case is_array($conn):
-                $conn = \Doctrine\DBAL\DriverManager::getConnection(
-                    $conn, $config, ($eventManager ?: new EventManager())
+            case is_array($connection):
+                $connection = \Doctrine\DBAL\DriverManager::getConnection(
+                    $connection, $config, ($eventManager ?: new EventManager())
                 );
                 break;
 
-            case $conn instanceof Connection:
-                if ($eventManager !== null && $conn->getEventManager() !== $eventManager) {
+            case $connection instanceof Connection:
+                if ($eventManager !== null && $connection->getEventManager() !== $eventManager) {
                     throw ORMException::mismatchedEventManager();
                 }
                 break;
@@ -85,6 +70,6 @@ public static function create($conn, Configuration $config, EventManager $eventM
                 throw new \InvalidArgumentException('Invalid argument');
         }
 
-        return new self($conn, $config, $conn->getEventManager());
+        return new self($connection, $config, $connection->getEventManager());
     }
 }
diff --git a/ORM/LoggingHydratorTrait.php b/ORM/LoggingHydratorTrait.php
@@ -14,24 +14,22 @@
 namespace Debesha\DoctrineProfileExtraBundle\ORM;
 
 use Countable;
+use Doctrine\DBAL\Result;
 use Doctrine\ORM\Internal\Hydration\ArrayHydrator;
 use Doctrine\ORM\Internal\Hydration\ObjectHydrator;
 use Doctrine\ORM\Internal\Hydration\ScalarHydrator;
 use Doctrine\ORM\Internal\Hydration\SimpleObjectHydrator;
 use Doctrine\ORM\Internal\Hydration\SingleScalarHydrator;
+use Doctrine\ORM\Query\ResultSetMapping;
 
 trait LoggingHydratorTrait
 {
     /**
      * Hydrates all rows returned by the passed statement instance at once.
      *
-     * @param \Doctrine\DBAL\Result $stmt
-     * @param \Doctrine\ORM\Query\ResultSetMapping $resultSetMapping
-     * @param array                                $hints
-     *
-     * @return array
+     * @param array $hints
      */
-    public function hydrateAll($stmt, $resultSetMapping, array $hints = [])
+    public function hydrateAll(Result $stmt, ResultSetMapping $resultSetMapping, array $hints = []): Countable|array
     {
         if ($logger = $this->_em->getConfiguration()->getHydrationLogger()) {
             $type = null;
@@ -54,8 +52,8 @@ public function hydrateAll($stmt, $resultSetMapping, array $hints = [])
         $result = parent::hydrateAll($stmt, $resultSetMapping, $hints);
 
         if ($logger) {
-            if (is_array($result) || $result instanceof Countable) {
-                $logger->stop(sizeof($result), $resultSetMapping->getAliasMap());
+            if (is_countable($result)) {
+                $logger->stop(count($result), $resultSetMapping->getAliasMap());
             }
         }
 

diff --git a/README.md b/README.md
@@ -8,13 +8,8 @@ Adds a section to web profile which lists all doctrine hydrations performed duri
 
 ## Installation
 
-Add this in your `composer.json`
-
-```php
-"require-dev": {
-    [...]
-    "debesha/doctrine-hydration-profiler-bundle" : "~1.0@dev",
-},
+```sh
+composer require "debesha/doctrine-hydration-profiler-bundle"
 ```
 
 Then run `php composer.phar update `

diff --git a/composer.json b/composer.json
@@ -8,9 +8,10 @@
         "extra",
         "bundle",
         "doctrine",
-        "symfony"
+        "symfony",
+        "dev"
     ],
-    "homepage": "http://github.com/debesha/DoctrineProfileExtraBundle",
+    "homepage": "https://github.com/debesha/DoctrineProfileExtraBundle",
     "license": "MIT",
     "authors": [
         {
@@ -19,12 +20,12 @@
         }
     ],
     "require": {
-        "php": ">=7.0",
-        "doctrine/orm": "^2.2",
-        "doctrine/doctrine-bundle": "^1.2|^2.0",
-        "symfony/framework-bundle": "^2.1|^3.0|^4.0|^5.0|^6.0",
-        "symfony/twig-bundle": "^2.0|^3.0|^4.0|^5.0|^6.0",
-        "twig/twig": "^1.12|^2.0|^3.0"
+        "php": ">=8.0",
+        "doctrine/orm": "^2.19",
+        "doctrine/doctrine-bundle": "^2.11",
+        "symfony/framework-bundle": "^5.4|^6.0|^7.0",
+        "symfony/twig-bundle": "^5.4|^6.0|^7.0",
+        "twig/twig": "^2.15.6|^3.8"
     },
     "require-dev": {
         "roave/security-advisories": "dev-latest"