mikekamornikov / UpgradeSpec

src/Formatter/FormatterInterface.php

Doc Comments +11 added lines

@@ -4,9 +4,20 @@
 
 interface FormatterInterface
 {
+    /**
+     * @param string $text
+     *
+     * @return string
+     */
     public function asTitle($text, $level = 1);
 
+    /**
+     * @return string
+     */
     public function asBody($text);
 
+    /**
+     * @return string
+     */
     public function getDelimiter();
 }

src/Template/RendererInterface.php

Doc Comments +2 added lines, -1 removed lines

@@ -7,8 +7,9 @@
     /**
      * Renders template.
      *
-     * @param $name
+     * @param string $name
      * @param $arguments
+     * @return string
      */
     public function render($name, $arguments);
 }

src/Updater/Adapter/AdapterInterface.php

Doc Comments +17 added lines

@@ -6,13 +6,30 @@
 
 interface AdapterInterface
 {
+    /**
+     * @return boolean
+     */
     public function hasUpdate();
 
+    /**
+     * @return string
+     */
     public function getOldVersion();
 
+    /**
+     * @return string
+     */
     public function getNewVersion();
 
+    /**
+     * @param string $stability
+     *
+     * @return boolean
+     */
     public function update($stability = Updater::STABILITY_ANY);
 
+    /**
+     * @return boolean
+     */
     public function rollback();
 }

src/Updater/Adapter/HumbugAdapter.php

Doc Comments +3 added lines, -3 removed lines

@@ -32,7 +32,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getOldVersion()
     {
@@ -40,7 +40,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getNewVersion()
     {
@@ -75,7 +75,7 @@ 
     }
 
     /**
-     * @param $stability
+     * @param string $stability
      *
      * @return string
      */

src/Data/Provider/Doc/SupportSugarcrm.php

Doc Comments +4 added lines, -4 removed lines

@@ -223,7 +223,7 @@ 
     /**
      * Returns the result (response body) of GET request.
      *
-     * @param $url
+     * @param string $url
      *
      * @return string
      */
@@ -235,7 +235,7 @@ 
     }
 
     /**
-     * @param $version
+     * @param string $version
      *
      * @return string
      */
@@ -245,7 +245,7 @@ 
     }
 
     /**
-     * @param $version
+     * @param string $version
      *
      * @return string
      */
@@ -329,7 +329,7 @@ 
     /**
      * Lightweight HTML purifier.
      *
-     * @param $html
+     * @param string $html
      * @param string $url
      * @param array  $options
      *

Spacing +8 added lines, -8 removed lines

@@ -73,7 +73,7 @@ 
         }
 
         // sort versions (ASC)
-        usort($versions, function ($v1, $v2) {
+        usort($versions, function($v1, $v2) {
             return version_compare($v1, $v2, '<') ? -1 : (version_compare($v1, $v2, '>') ? 1 : 0);
         });
 
@@ -90,13 +90,13 @@ 
      */
     public function getReleaseNotes($flav, array $versions)
     {
-        $newVersions = array_filter($versions, function ($version) use ($flav) {
+        $newVersions = array_filter($versions, function($version) use ($flav) {
             return !$this->cache->has($this->getCacheKey([$flav, 'release_notes', $version]));
         });
 
-        $requests = function () use ($flav, $newVersions) {
+        $requests = function() use ($flav, $newVersions) {
             foreach ($newVersions as $version) {
-                yield $version => function () use ($flav, $version) {
+                yield $version => function() use ($flav, $version) {
                     return $this->httpClient->getAsync($this->getReleaseNotesUri($flav, $version));
                 };
             }
@@ -104,7 +104,7 @@ 
 
         if ($newVersions) {
             $this->processRequestPool($requests, [
-                'fulfilled' => function (ResponseInterface $response, $version) use ($flav) {
+                'fulfilled' => function(ResponseInterface $response, $version) use ($flav) {
                     $html = $response->getBody()->getContents();
                     $crawler = new Crawler($this->purifyHtml($html, $this->getReleaseNotesUri($flav, $version)));
 
@@ -134,7 +134,7 @@ 
 
                     $this->cache->set($this->getCacheKey([$flav, 'release_notes', $version]), $releaseNote);
                 },
-                'rejected' => function ($reason, $version) {
+                'rejected' => function($reason, $version) {
                     throw new \RuntimeException(
                         sprintf('Can\'t get release notes for version: %s (reason: %s)', $version, $reason)
                     );
@@ -150,7 +150,7 @@ 
             }
         }
 
-        uksort($releaseNotes, function ($v1, $v2) {
+        uksort($releaseNotes, function($v1, $v2) {
             return version_compare($v1, $v2, '<') ? -1 : (version_compare($v1, $v2, '>') ? 1 : 0);
         });
 
@@ -319,7 +319,7 @@ 
     {
         $delimiter = '___';
 
-        return implode($delimiter, array_map(function ($key) {
+        return implode($delimiter, array_map(function($key) {
             return preg_replace('/[^a-zA-Z0-9_\.]+/', '', mb_strtolower($key));
         }, $keyParts));
     }

src/Data/Provider/SourceCode/LocalUpgradePackages.php

Doc Comments +5 added lines, -5 removed lines

@@ -45,7 +45,7 @@ 
     }
 
     /**
-     * @param $buildPath
+     * @param string $buildPath
      * @param $packages
      *
      * @return array
@@ -141,8 +141,8 @@ 
     /**
      * Gets flav specific packages
      *
-     * @param $flav
-     * @param $packagesPath
+     * @param string $flav
+     * @param string $packagesPath
      *
      * @return array
      */
@@ -196,8 +196,8 @@ 
      * Calculates an array of possible upgrade chains
      *
      * @param $packages
-     * @param $buildVersion
-     * @param $upgradeTo
+     * @param string $buildVersion
+     * @param string $upgradeTo
      *
      * @return array
      */

Spacing +11 added lines, -11 removed lines

@@ -77,7 +77,7 @@ 
             $deletedFiles = array_diff(array_merge($deletedFiles, $packageDeletedFiles), $packageModifiedFiles);
         }
 
-        $modifiedFiles = array_keys(array_filter($modifiedFiles, function ($package, $changedFile) use ($buildPath, $packageZips) {
+        $modifiedFiles = array_keys(array_filter($modifiedFiles, function($package, $changedFile) use ($buildPath, $packageZips) {
             if (($buildFile = @file_get_contents($buildPath . DS . $changedFile)) === false) {
                 return false;
             }
@@ -92,11 +92,11 @@ 
             $zip->close();
         }
 
-        $modifiedFiles = array_values(array_filter($modifiedFiles, function ($file) use ($buildPath) {
+        $modifiedFiles = array_values(array_filter($modifiedFiles, function($file) use ($buildPath) {
             return file_exists($buildPath . '/custom/' . $file);
         }));
 
-        $deletedFiles = array_values(array_filter($deletedFiles, function ($file) use ($buildPath) {
+        $deletedFiles = array_values(array_filter($deletedFiles, function($file) use ($buildPath) {
             return file_exists($buildPath . '/custom/' . $file);
         }));
 
@@ -129,7 +129,7 @@ 
             return $this->suitablePackages;
         }
 
-        usort($upgradeChains, function ($a1, $a2) {
+        usort($upgradeChains, function($a1, $a2) {
             return count($a1) < count($a2) ? -1 : (count($a1) > count($a2) ? 1 : 0);
         });
 
@@ -211,7 +211,7 @@ 
         $versionMatrix = $this->getVersionMatrix($packages);
         $allVersions = array_keys($versionMatrix);
 
-        $getExistingSubversions = function ($version) use ($allVersions) {
+        $getExistingSubversions = function($version) use ($allVersions) {
             $existingVersions = [];
 
             $fromParts = explode('.', $version);
@@ -226,7 +226,7 @@ 
         };
 
         // init chains with starting versions
-        $chains = array_map(function ($version) use ($buildVersion) {
+        $chains = array_map(function($version) use ($buildVersion) {
             return [$version => $buildVersion];
         }, $getExistingSubversions($buildVersion));
 
@@ -236,7 +236,7 @@ 
         }
 
         // gets last key of assoc array
-        $getLastKey = function ($array) {
+        $getLastKey = function($array) {
             end($array);
 
             return key($array);
@@ -285,7 +285,7 @@ 
             $chains = $fullChains;
         }
 
-        $chains = array_map(function ($chain) use ($versionMatrix) {
+        $chains = array_map(function($chain) use ($versionMatrix) {
             $keys = array_keys($chain);
             $values = array_values($chain);
 
@@ -315,17 +315,17 @@ 
      */
     private function getVersionMatrix($packages)
     {
-        $allVersions = array_unique(call_user_func_array('array_merge', array_map(function ($package) {
+        $allVersions = array_unique(call_user_func_array('array_merge', array_map(function($package) {
             return [$package['from'], $package['to']];
         }, $packages)));
 
         // sort versions (ASC)
-        usort($allVersions, function ($v1, $v2) {
+        usort($allVersions, function($v1, $v2) {
             return version_compare($v1, $v2, '<') ? -1 : (version_compare($v1, $v2, '>') ? 1 : 0);
         });
 
         // create matrix and fill it with zeros
-        $versionMatrix = call_user_func_array('array_merge',array_map(function ($version) use ($allVersions) {
+        $versionMatrix = call_user_func_array('array_merge', array_map(function($version) use ($allVersions) {
             return [$version => array_combine($allVersions, array_fill(0, count($allVersions), 0))];
         }, $allVersions));
 

src/Element/Section/UpgradeChanges.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
     /**
      * @param Upgrade $context
      *
-     * @return bool
+     * @return string
      */
     public function isRelevantTo(Upgrade $context)
     {

src/Element/Provider.php

Spacing +2 added lines, -2 removed lines

@@ -50,7 +50,7 @@ 
      */
     public function getSuitableElements(Upgrade $context)
     {
-        $elements = array_filter($this->specElements, function (ElementInterface $element) use ($context) {
+        $elements = array_filter($this->specElements, function(ElementInterface $element) use ($context) {
             return $element->isRelevantTo($context);
         });
 
@@ -63,7 +63,7 @@ 
         }
 
         // sort elements (ASC)
-        usort($elements, function (ElementInterface $a, ElementInterface $b) {
+        usort($elements, function(ElementInterface $a, ElementInterface $b) {
             return $a->getOrder() > $b->getOrder() ? 1 : ($a->getOrder() < $b->getOrder() ? -1 : 0);
         });