Merge pull request #37 from redthor/fix/cleanup-scrutinizer-issues

redthor · web-flow · commit 0607e7ed3f58 · 2018-05-06T22:49:28.000+10:00
Fix/cleanup scrutinizer issues
diff --git a/src/AntiMattr/MongoDB/Migrations/AbstractMigration.php b/src/AntiMattr/MongoDB/Migrations/AbstractMigration.php
@@ -23,17 +23,17 @@
 abstract class AbstractMigration
 {
     /**
-     * @var AntiMattr\MongoDB\Migrations\Configuration\Configuration
+     * @var \AntiMattr\MongoDB\Migrations\Configuration\Configuration
      */
     private $configuration;
 
     /**
-     * @var AntiMattr\MongoDB\Migrations\OutputWriter
+     * @var \AntiMattr\MongoDB\Migrations\OutputWriter
      */
     private $outputWriter;
 
     /**
-     * @var AntiMattr\MongoDB\Migrations\Version
+     * @var \AntiMattr\MongoDB\Migrations\Version
      */
     protected $version;
 
@@ -56,15 +56,15 @@ abstract public function up(Database $db);
     abstract public function down(Database $db);
 
     /**
-     * @param Doctrine\MongoDB\Collection
+     * @param \Doctrine\MongoDB\Collection
      */
     protected function analyze(Collection $collection)
     {
         $this->version->analyze($collection);
     }
 
     /**
-     * @param Doctrine\MongoDB\Database
+     * @param \Doctrine\MongoDB\Database
      * @param string $filename
      */
     protected function executeScript(Database $db, $filename)
diff --git a/src/AntiMattr/MongoDB/Migrations/Collection/Statistics.php b/src/AntiMattr/MongoDB/Migrations/Collection/Statistics.php
@@ -42,7 +42,7 @@ class Statistics
     ];
 
     /**
-     * @var Doctrine\MongoDB\Collection
+     * @var \Doctrine\MongoDB\Collection
      */
     private $collection;
 
@@ -57,15 +57,15 @@ class Statistics
     private $after = [];
 
     /**
-     * @param Doctrine\MongoDB\Collection
+     * @param \Doctrine\MongoDB\Collection
      */
     public function setCollection(Collection $collection)
     {
         $this->collection = $collection;
     }
 
     /**
-     * @return Doctrine\MongoDB\Collection
+     * @return \Doctrine\MongoDB\Collection
      */
     public function getCollection()
     {
diff --git a/src/AntiMattr/MongoDB/Migrations/Configuration/Configuration.php b/src/AntiMattr/MongoDB/Migrations/Configuration/Configuration.php
@@ -25,22 +25,22 @@
 class Configuration
 {
     /**
-     * @var Doctrine\MongoDB\Collection
+     * @var \Doctrine\MongoDB\Collection
      */
     private $collection;
 
     /**
-     * @var Doctrine\MongoDB\Connection
+     * @var \Doctrine\MongoDB\Connection
      */
     private $connection;
 
     /**
-     * @var Doctrine\MongoDB\Database
+     * @var \Doctrine\MongoDB\Database
      */
     private $database;
 
     /**
-     * @var Doctrine\MongoDB\Connection
+     * @var \Doctrine\MongoDB\Connection
      */
     private $migrationsDatabase;
 
@@ -94,18 +94,18 @@ class Configuration
     private $name;
 
     /**
-     * @var AntiMattr\MongoDB\Migrations\Version[]
+     * @var \AntiMattr\MongoDB\Migrations\Version[]
      */
     protected $migrations = [];
 
     /**
-     * @var AntiMattr\MongoDB\Migrations\OutputWriter
+     * @var \AntiMattr\MongoDB\Migrations\OutputWriter
      */
     private $outputWriter;
 
     /**
-     * @param Doctrine\MongoDB\Connection               $connection
-     * @param AntiMattr\MongoDB\Migrations\OutputWriter $outputWriter
+     * @param \Doctrine\MongoDB\Connection               $connection
+     * @param \AntiMattr\MongoDB\Migrations\OutputWriter $outputWriter
      */
     public function __construct(Connection $connection, OutputWriter $outputWriter = null)
     {
@@ -151,7 +151,7 @@ public function getAvailableVersions()
     }
 
     /**
-     * @return Doctrine\MongoDB\Collection
+     * @return \Doctrine\MongoDB\Collection
      */
     public function getCollection()
     {
@@ -165,15 +165,15 @@ public function getCollection()
     }
 
     /**
-     * @return Doctrine\MongoDB\Connection
+     * @return \Doctrine\MongoDB\Connection
      */
     public function getConnection()
     {
         return $this->connection;
     }
 
     /**
-     * @return Doctrine\MongoDB\Database
+     * @return \Doctrine\MongoDB\Database
      */
     public function getDatabase(): ?Database
     {
@@ -281,7 +281,7 @@ public function getMigrationsScriptDirectory()
     /**
      * Returns all migrated versions from the versions collection, in an array.
      *
-     * @return AntiMattr\MongoDB\Migrations\Version[]
+     * @return \AntiMattr\MongoDB\Migrations\Version[]
      */
     public function getMigratedVersions()
     {
@@ -301,12 +301,12 @@ public function getMigratedVersions()
      *
      * @param string $version
      *
-     * @return string
+     * @return int
      *
      * @throws AntiMattr\MongoDB\Migrations\Exception\UnknownVersionException Throws exception if migration version does not exist
      * @throws DomainException                                                If more than one version exists
      */
-    public function getMigratedTimestamp($version)
+    public function getMigratedTimestamp($version): int
     {
         $this->createMigrationCollection();
 
@@ -329,7 +329,7 @@ public function getMigratedTimestamp($version)
         // Convert to normalised timestamp
         $ts = new Timestamp($returnVersion['t']);
 
-        return (string) $ts;
+        return $ts->getTimestamp();
     }
 
     /**
@@ -379,7 +379,7 @@ public function getNumberOfExecutedMigrations()
     }
 
     /**
-     * @return AntiMattr\MongoDB\Migrations\OutputWriter
+     * @return \AntiMattr\MongoDB\Migrations\OutputWriter
      */
     public function getOutputWriter()
     {
@@ -468,7 +468,7 @@ public function registerMigrationsFromDirectory($path)
      *
      * @param string $version The version string in the format YYYYMMDDHHMMSS
      *
-     * @return AntiMattr\MongoDB\Migrations\Version
+     * @return \AntiMattr\MongoDB\Migrations\Version
      *
      * @throws AntiMattr\MongoDB\Migrations\Exception\UnknownVersionException Throws exception if migration version does not exist
      */
@@ -496,7 +496,7 @@ public function hasVersion($version)
     /**
      * Check if a version has been migrated or not yet.
      *
-     * @param AntiMattr\MongoDB\Migrations\Version $version
+     * @param \AntiMattr\MongoDB\Migrations\Version $version
      *
      * @return bool
      */
@@ -517,7 +517,7 @@ public function getCurrentVersion()
         $this->createMigrationCollection();
 
         $migratedVersions = [];
-        if ($this->migrations) {
+        if (!empty($this->migrations)) {
             foreach ($this->migrations as $migration) {
                 $migratedVersions[] = $migration->getVersion();
             }
diff --git a/src/AntiMattr/MongoDB/Migrations/Migration.php b/src/AntiMattr/MongoDB/Migrations/Migration.php
@@ -81,7 +81,7 @@ public function migrate($to = null)
 
         $time = 0;
         foreach ($migrationsToExecute as $version) {
-            $versionSql = $version->execute($direction);
+            $version->execute($direction);
             $time += $version->getTime();
         }
 
diff --git a/src/AntiMattr/MongoDB/Migrations/Tools/Console/Command/AbstractCommand.php b/src/AntiMattr/MongoDB/Migrations/Tools/Console/Command/AbstractCommand.php
@@ -25,7 +25,7 @@
 abstract class AbstractCommand extends Command
 {
     /**
-     * @var AntiMattr\MongoDB\Migrations\Configuration\Configuration
+     * @var \AntiMattr\MongoDB\Migrations\Configuration\Configuration
      */
     private $configuration;
 
@@ -43,8 +43,8 @@ protected function configure()
     }
 
     /**
-     * @param AntiMattr\MongoDB\Migrations\Configuration\Configuration
-     * @param Symfony\Component\Console\Output\OutputInterface
+     * @param \AntiMattr\MongoDB\Migrations\Configuration\Configuration $configuration
+     * @param \Symfony\Component\Console\Output\OutputInterface         $output
      */
     protected function outputHeader(Configuration $configuration, OutputInterface $output)
     {
@@ -58,18 +58,18 @@ protected function outputHeader(Configuration $configuration, OutputInterface $o
     }
 
     /**
-     * @param AntiMattr\MongoDB\Migrations\Configuration\Configuration
+     * @param \AntiMattr\MongoDB\Migrations\Configuration\Configuration
      */
     public function setMigrationConfiguration(Configuration $config)
     {
         $this->configuration = $config;
     }
 
     /**
-     * @param Symfony\Component\Console\Output\InputInterface  $input
-     * @param Symfony\Component\Console\Output\OutputInterface $output
+     * @param \Symfony\Component\Console\Input\InputInterface   $input
+     * @param \Symfony\Component\Console\Output\OutputInterface $output
      *
-     * @return AntiMattr\MongoDB\Migrations\Configuration\Configuration
+     * @return \AntiMattr\MongoDB\Migrations\Configuration\Configuration
      */
     protected function getMigrationConfiguration(InputInterface $input, OutputInterface $output)
     {
@@ -112,9 +112,9 @@ protected function getMigrationConfiguration(InputInterface $input, OutputInterf
     }
 
     /**
-     * @params array $params
+     * @param array $params
      *
-     * @return Doctrine\MongoDB\Connection
+     * @return \Doctrine\MongoDB\Connection
      */
     protected function createConnection($params)
     {
diff --git a/src/AntiMattr/MongoDB/Migrations/Tools/Console/Command/ExecuteCommand.php b/src/AntiMattr/MongoDB/Migrations/Tools/Console/Command/ExecuteCommand.php
@@ -53,8 +53,8 @@ protected function configure()
     }
 
     /**
-     * @param Symfony\Component\Console\Input\InputInterface
-     * @param Symfony\Component\Console\Output\OutputInterface
+     * @param \Symfony\Component\Console\Input\InputInterface
+     * @param \Symfony\Component\Console\Output\OutputInterface
      */
     public function execute(InputInterface $input, OutputInterface $output)
     {
diff --git a/src/AntiMattr/MongoDB/Migrations/Tools/Console/Command/GenerateCommand.php b/src/AntiMattr/MongoDB/Migrations/Tools/Console/Command/GenerateCommand.php
@@ -79,8 +79,8 @@ protected function configure()
     }
 
     /**
-     * @param Symfony\Component\Console\Input\InputInterface
-     * @param Symfony\Component\Console\Output\OutputInterface
+     * @param \Symfony\Component\Console\Input\InputInterface
+     * @param \Symfony\Component\Console\Output\OutputInterface
      */
     public function execute(InputInterface $input, OutputInterface $output)
     {
@@ -93,8 +93,8 @@ public function execute(InputInterface $input, OutputInterface $output)
     }
 
     /**
-     * @param AntiMattr\MongoDB\Migrations\Configuration\Configuration
-     * @param Symfony\Component\Console\Input\InputInterface
+     * @param \AntiMattr\MongoDB\Migrations\Configuration\Configuration
+     * @param \Symfony\Component\Console\Input\InputInterface
      * @param string $version
      * @param string $up
      * @param string $down
diff --git a/src/AntiMattr/MongoDB/Migrations/Tools/Console/Command/MigrateCommand.php b/src/AntiMattr/MongoDB/Migrations/Tools/Console/Command/MigrateCommand.php
@@ -51,8 +51,8 @@ protected function configure()
     }
 
     /**
-     * @param Symfony\Component\Console\Input\InputInterface
-     * @param Symfony\Component\Console\Output\OutputInterface
+     * @param \Symfony\Component\Console\Input\InputInterface
+     * @param \Symfony\Component\Console\Output\OutputInterface
      */
     public function execute(InputInterface $input, OutputInterface $output)
     {
diff --git a/src/AntiMattr/MongoDB/Migrations/Tools/Console/Command/StatusCommand.php b/src/AntiMattr/MongoDB/Migrations/Tools/Console/Command/StatusCommand.php
@@ -52,8 +52,8 @@ protected function configure()
     }
 
     /**
-     * @param Symfony\Component\Console\Input\InputInterface
-     * @param Symfony\Component\Console\Output\OutputInterface
+     * @param \Symfony\Component\Console\Input\InputInterface
+     * @param \Symfony\Component\Console\Output\OutputInterface
      */
     public function execute(InputInterface $input, OutputInterface $output)
     {
@@ -146,7 +146,7 @@ public function execute(InputInterface $input, OutputInterface $output)
             }
 
             $executedUnavailableMigrations = $configuration->getUnavailableMigratedVersions();
-            if ($executedUnavailableMigrations) {
+            if (!empty($executedUnavailableMigrations)) {
                 $output->writeln("\n <info>==</info> Previously Executed Unavailable Migration Versions\n");
                 foreach ($executedUnavailableMigrations as $executedUnavailableMigration) {
                     $output->writeln(
diff --git a/src/AntiMattr/MongoDB/Migrations/Tools/Console/Command/VersionCommand.php b/src/AntiMattr/MongoDB/Migrations/Tools/Console/Command/VersionCommand.php
@@ -49,8 +49,8 @@ protected function configure()
     }
 
     /**
-     * @param Symfony\Component\Console\Input\InputInterface
-     * @param Symfony\Component\Console\Output\OutputInterface
+     * @param \Symfony\Component\Console\Input\InputInterface
+     * @param \Symfony\Component\Console\Output\OutputInterface
      *
      * @throws AntiMattr\MongoDB\Migrations\Exception\UnknownVersionException Throws exception if migration version does not exist
      * @throws InvalidArgumentException
diff --git a/src/AntiMattr/MongoDB/Migrations/Version.php b/src/AntiMattr/MongoDB/Migrations/Version.php

Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ public function migrate($to = null)`
`81`	`81`
`82`	`82`	`$time = 0;`
`83`	`83`	`foreach ($migrationsToExecute as $version) {`
`84`		`- $versionSql = $version->execute($direction);`
	`84`	`+ $version->execute($direction);`
`85`	`85`	`$time += $version->getTime();`
`86`	`86`	`}`
`87`	`87`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`abstract class AbstractCommand extends Command`
`26`	`26`	`{`
`27`	`27`	`/**`
`28`		`- * @var AntiMattr\MongoDB\Migrations\Configuration\Configuration`
	`28`	`+ * @var \AntiMattr\MongoDB\Migrations\Configuration\Configuration`
`29`	`29`	`*/`
`30`	`30`	`private $configuration;`
`31`	`31`
`@@ -43,8 +43,8 @@ protected function configure()`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`/**`
`46`		`- * @param AntiMattr\MongoDB\Migrations\Configuration\Configuration`
`47`		`- * @param Symfony\Component\Console\Output\OutputInterface`
	`46`	`+ * @param \AntiMattr\MongoDB\Migrations\Configuration\Configuration $configuration`
	`47`	`+ * @param \Symfony\Component\Console\Output\OutputInterface $output`
`48`	`48`	`*/`
`49`	`49`	`protected function outputHeader(Configuration $configuration, OutputInterface $output)`
`50`	`50`	`{`
`@@ -58,18 +58,18 @@ protected function outputHeader(Configuration $configuration, OutputInterface $o`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`/**`
`61`		`- * @param AntiMattr\MongoDB\Migrations\Configuration\Configuration`
	`61`	`+ * @param \AntiMattr\MongoDB\Migrations\Configuration\Configuration`
`62`	`62`	`*/`
`63`	`63`	`public function setMigrationConfiguration(Configuration $config)`
`64`	`64`	`{`
`65`	`65`	`$this->configuration = $config;`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`/**`
`69`		`- * @param Symfony\Component\Console\Output\InputInterface $input`
`70`		`- * @param Symfony\Component\Console\Output\OutputInterface $output`
	`69`	`+ * @param \Symfony\Component\Console\Input\InputInterface $input`
	`70`	`+ * @param \Symfony\Component\Console\Output\OutputInterface $output`
`71`	`71`	`*`
`72`		`- * @return AntiMattr\MongoDB\Migrations\Configuration\Configuration`
	`72`	`+ * @return \AntiMattr\MongoDB\Migrations\Configuration\Configuration`
`73`	`73`	`*/`
`74`	`74`	`protected function getMigrationConfiguration(InputInterface $input, OutputInterface $output)`
`75`	`75`	`{`
`@@ -112,9 +112,9 @@ protected function getMigrationConfiguration(InputInterface $input, OutputInterf`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`/**`
`115`		`- * @params array $params`
	`115`	`+ * @param array $params`
`116`	`116`	`*`
`117`		`- * @return Doctrine\MongoDB\Connection`
	`117`	`+ * @return \Doctrine\MongoDB\Connection`
`118`	`118`	`*/`
`119`	`119`	`protected function createConnection($params)`
`120`	`120`	`{`
Original file line number	Diff line number	Diff line change
`@@ -53,8 +53,8 @@ protected function configure()`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`/**`
`56`		`- * @param Symfony\Component\Console\Input\InputInterface`
`57`		`- * @param Symfony\Component\Console\Output\OutputInterface`
	`56`	`+ * @param \Symfony\Component\Console\Input\InputInterface`
	`57`	`+ * @param \Symfony\Component\Console\Output\OutputInterface`
`58`	`58`	`*/`
`59`	`59`	`public function execute(InputInterface $input, OutputInterface $output)`
`60`	`60`	`{`
Original file line number	Diff line number	Diff line change
`@@ -79,8 +79,8 @@ protected function configure()`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`/**`
`82`		`- * @param Symfony\Component\Console\Input\InputInterface`
`83`		`- * @param Symfony\Component\Console\Output\OutputInterface`
	`82`	`+ * @param \Symfony\Component\Console\Input\InputInterface`
	`83`	`+ * @param \Symfony\Component\Console\Output\OutputInterface`
`84`	`84`	`*/`
`85`	`85`	`public function execute(InputInterface $input, OutputInterface $output)`
`86`	`86`	`{`
`@@ -93,8 +93,8 @@ public function execute(InputInterface $input, OutputInterface $output)`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`/**`
`96`		`- * @param AntiMattr\MongoDB\Migrations\Configuration\Configuration`
`97`		`- * @param Symfony\Component\Console\Input\InputInterface`
	`96`	`+ * @param \AntiMattr\MongoDB\Migrations\Configuration\Configuration`
	`97`	`+ * @param \Symfony\Component\Console\Input\InputInterface`
`98`	`98`	`* @param string $version`
`99`	`99`	`* @param string $up`
`100`	`100`	`* @param string $down`
Original file line number	Diff line number	Diff line change
`@@ -51,8 +51,8 @@ protected function configure()`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`/**`
`54`		`- * @param Symfony\Component\Console\Input\InputInterface`
`55`		`- * @param Symfony\Component\Console\Output\OutputInterface`
	`54`	`+ * @param \Symfony\Component\Console\Input\InputInterface`
	`55`	`+ * @param \Symfony\Component\Console\Output\OutputInterface`
`56`	`56`	`*/`
`57`	`57`	`public function execute(InputInterface $input, OutputInterface $output)`
`58`	`58`	`{`
Original file line number	Diff line number	Diff line change
`@@ -52,8 +52,8 @@ protected function configure()`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`/**`
`55`		`- * @param Symfony\Component\Console\Input\InputInterface`
`56`		`- * @param Symfony\Component\Console\Output\OutputInterface`
	`55`	`+ * @param \Symfony\Component\Console\Input\InputInterface`
	`56`	`+ * @param \Symfony\Component\Console\Output\OutputInterface`
`57`	`57`	`*/`
`58`	`58`	`public function execute(InputInterface $input, OutputInterface $output)`
`59`	`59`	`{`
`@@ -146,7 +146,7 @@ public function execute(InputInterface $input, OutputInterface $output)`
`146`	`146`	`}`
`147`	`147`
`148`	`148`	`$executedUnavailableMigrations = $configuration->getUnavailableMigratedVersions();`
`149`		`- if ($executedUnavailableMigrations) {`
	`149`	`+ if (!empty($executedUnavailableMigrations)) {`
`150`	`150`	`$output->writeln("\n <info>==</info> Previously Executed Unavailable Migration Versions\n");`
`151`	`151`	`foreach ($executedUnavailableMigrations as $executedUnavailableMigration) {`
`152`	`152`	`$output->writeln(`
Original file line number	Diff line number	Diff line change
`@@ -49,8 +49,8 @@ protected function configure()`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`/**`
`52`		`- * @param Symfony\Component\Console\Input\InputInterface`
`53`		`- * @param Symfony\Component\Console\Output\OutputInterface`
	`52`	`+ * @param \Symfony\Component\Console\Input\InputInterface`
	`53`	`+ * @param \Symfony\Component\Console\Output\OutputInterface`
`54`	`54`	`*`
`55`	`55`	`* @throws AntiMattr\MongoDB\Migrations\Exception\UnknownVersionException Throws exception if migration version does not exist`
`56`	`56`	`* @throws InvalidArgumentException`