extensive improvement of function descriptions and tags

Author: mirko-pagliai

CHANGELOG.md

@@ -1,5 +1,8 @@
 # 2.x branch
 ## 2.8 branch
+### 2.8.5
+* extensive improvement of function descriptions and tags.
+
 ### 2.8.4
 * `BackupManager::delete()` returns the full path;
 * all methods provided by `BackupManager` can now be called statically, except

phpstan.neon

@@ -21,12 +21,8 @@ parameters:
         - "#^Constant REDIRECT_TO_DEV_NULL not found\\.$#"
         - '#^Parameter \#1 \$callback of function array_map expects \(callable\(\): mixed\)\|null#'
         - "#^Static call to instance method Tools\\\\Exceptionist#"
-        - "#^Parameter \\#2 \\$eventManager of method Cake\\\\TestSuite\\\\TestCase\\:\\:assertEventFired\\(\\) expects Cake\\\\Event\\\\EventManager\\|null, Cake\\\\Event\\\\EventManagerInterface given\\.$#"
-        - "#^Parameter \\#1 \\$connection of method Cake\\\\Database\\\\Schema\\\\TableSchema\\:\\:dropSql\\(\\) expects Cake\\\\Database\\\\Connection, Cake\\\\Datasource\\\\ConnectionInterface given\\.$#"
-
-        -
-            message: "#^Call to an undefined method Cake\\\\Datasource\\\\ConnectionInterface#"
-            path: src/Driver/Sqlite.php
+        - '#^Parameter \#\d \$\w+ of method Cake\\[\w\:\\]+\(\) expects#'
+        - '#^Call to an undefined method Cake\\#'
 
         -
             message: '#^Call to an undefined method [\w\|\\]+MockObject::\w+\(\)\.$#'

psalm.xml

@@ -55,6 +55,7 @@
         <UndefinedInterfaceMethod>
             <errorLevel type="suppress">
                 <file name="src/Driver/Sqlite.php" />
+                <file name="src/TestSuite/DriverTestCase.php" />
             </errorLevel>
         </UndefinedInterfaceMethod>
     </issueHandlers>

src/BackupTrait.php

@@ -18,6 +18,7 @@
 use Cake\Core\Configure;
 use Cake\Datasource\ConnectionInterface;
 use Cake\Datasource\ConnectionManager;
+use DatabaseBackup\Driver\Driver;
 use InvalidArgumentException;
 use Tools\Exceptionist;
 use Tools\Filesystem;
@@ -30,7 +31,7 @@ trait BackupTrait
     /**
      * Valid extensions. Names as keys and compressions as values
      * @since 2.4.0
-     * @var array
+     * @var array<string, string|bool>
      */
     protected static $validExtensions = ['sql.bz2' => 'bzip2', 'sql.gz' => 'gzip', 'sql' => false];
 
@@ -77,7 +78,7 @@ public function getConnection(?string $name = null): ConnectionInterface
      * @throws \InvalidArgumentException
      * @uses getConnection()
      */
-    public function getDriver(?ConnectionInterface $connection = null): object
+    public function getDriver(?ConnectionInterface $connection = null): Driver
     {
         $connection = $connection ?: $this->getConnection();
         $className = get_class_short_name($connection->getDriver());
@@ -103,7 +104,7 @@ public static function getExtension(string $filename): ?string
 
     /**
      * Returns all valid compressions
-     * @return array<string, string>
+     * @return array
      * @since 2.4.0
      * @uses $validExtensions
      */

src/Driver/Driver.php

@@ -103,7 +103,7 @@ public function afterImport(): void
      * @return bool Returns `false` to stop the export
      * @since 2.1.0
      */
-    public function beforeExport()
+    public function beforeExport(): bool
     {
         return true;
     }
@@ -199,7 +199,7 @@ final public function export(string $filename): bool
      * @return string
      * @throws \ErrorException
      */
-    public function getBinary($name)
+    public function getBinary(string $name): string
     {
         $binary = Configure::read('DatabaseBackup.binaries.' . $name);
 

src/TestSuite/DriverTestCase.php

@@ -47,7 +47,7 @@ abstract class DriverTestCase extends TestCase
     /**
      * Driver class
      * @since 2.5.1
-     * @var string
+     * @var class-string<\DatabaseBackup\Driver\Driver>
      */
     protected $DriverClass;
 

src/TestSuite/TestCase.php

@@ -88,11 +88,11 @@ protected function createSomeBackups(): array
 
     /**
      * Internal method to mock a driver
-     * @param class-string<object> $className Driver class name
-     * @param array $methods The list of methods to mock
+     * @param class-string<\DatabaseBackup\Driver\Driver> $className Driver class name
+     * @param array|null $methods The list of methods to mock
      * @return \DatabaseBackup\Driver\Driver|\PHPUnit\Framework\MockObject\MockObject
      */
-    protected function getMockForDriver(string $className, array $methods)
+    protected function getMockForDriver(string $className, ?array $methods = []): object
     {
         return $this->getMockBuilder($className)
             ->setMethods($methods)

src/Utility/BackupExport.php

@@ -116,7 +116,7 @@ public function compression(?string $compression)
         $this->extension = $this->defaultExtension;
 
         if ($compression) {
-            $this->extension = array_search($compression, $this->getValidCompressions()) ?: '';
+            $this->extension = (string)array_search($compression, $this->getValidCompressions());
             Exceptionist::isTrue($this->extension, __d('database_backup', 'Invalid compression type'), InvalidArgumentException::class);
         }
         $this->compression = $compression;

version

@@ -1 +1 @@
-2.8.4
+2.8.5