consolidation / site-alias

src/HostPath.php

Unused Use Statements -2 removed lines

@@ -1,8 +1,6 @@
 <?php
 namespace Consolidation\SiteAlias;
 
-use Consolidation\Config\Config;
-use Consolidation\Config\ConfigInterface;
 use Webmozart\PathUtil\Path;
 
 /**

src/SiteAliasName.php

Doc Comments +2 added lines, -3 removed lines

@@ -80,7 +80,7 @@ 
      * are defined by the alias contents.
      *
      * @param type $path
-     * @return type
+     * @return string
      */
     public static function locationFromPath($path)
     {
@@ -315,8 +315,7 @@ 
     /**
      * Process an alias name provided as '@sitename'.
      *
-     * @param string $sitename
-     * @return true
+     * @return boolean
      */
     protected function processSingleItem($item)
     {

src/SiteAliasFileDiscovery.php

Doc Comments +2 added lines, -2 removed lines

@@ -36,7 +36,7 @@ 
     /**
      * Add a location that alias files may be found.
      *
-     * @param string $path
+     * @param string $paths
      * @return $this
      */
     public function addSearchLocation($paths)
@@ -105,7 +105,7 @@ 
      * of the specified search locations.
      *
      * @param string $siteName
-     * @return string|bool
+     * @return false|string
      */
     public function findSingleSiteAliasFile($siteName)
     {

src/Cli/SiteAliasCommands.php

Doc Comments +3 added lines

@@ -54,6 +54,9 @@
         return $this->renderAliases($all);
     }
 
+    /**
+     * @return string
+     */
     protected function getLocationsAndAliasName($varArgs)
     {
         $aliasName = '';

src/SiteAlias.php

Unused Use Statements -3 removed lines

@@ -2,9 +2,6 @@
 namespace Consolidation\SiteAlias;
 
 use Consolidation\Config\Config;
-use Consolidation\Config\ConfigInterface;
-use Consolidation\Config\Util\ArrayUtil;
-use Consolidation\SiteAlias\Util\FsUtils;
 
 /**
  * An alias record is a configuration record containing well-known items.

src/SiteAliasTrait.php

Doc Comments +1 added lines

@@ -122,6 +122,7 @@
 
     /**
      * @inheritdoc
+     * @return string
      */
     public function localRoot()
     {

Unused Use Statements -3 removed lines

@@ -1,9 +1,6 @@
 <?php
 namespace Consolidation\SiteAlias;
 
-use Consolidation\Config\Config;
-use Consolidation\Config\ConfigInterface;
-use Consolidation\Config\Util\ArrayUtil;
 use Consolidation\SiteAlias\Util\FsUtils;
 
 /**

src/SiteAliasWithConfig.php

Doc Comments +2 added lines, -1 removed lines

@@ -33,7 +33,7 @@ 
     /**
      * combine the provided site alias with configuration.
      *
-     * @return SiteAlias read-only site alias combined with the runtime
+     * @return SiteAliasWithConfig read-only site alias combined with the runtime
      *   config (overrides the site alias values) and the default config.
      */
     public static function create(SiteAliasInterface $siteAlias, ConfigInterface $defaultConfig, ConfigInterface $runtimeConfig = null)
@@ -47,6 +47,7 @@ 
      * Determine what object to use for the runtime config. If a specific
      * runtime config is given, use that. Otherwise, pull it from the default
      * configuration if available.
+     * @return ConfigInterface
      */
     protected static function determineCorrectRuntimeConfig(ConfigInterface $defaultConfig, ConfigInterface $runtimeConfig)
     {

src/SiteAliasFileLoader.php

Doc Comments +7 added lines, -2 removed lines

@@ -54,6 +54,7 @@ 
 
     /**
      * Allow 'self.site.yml' to be applied to any alias record found.
+     * @param string $root
      */
     public function setRoot($root)
     {
@@ -117,6 +118,7 @@ 
 
     /**
      * Given only a site name, load the default environment from it.
+     * @param string|null $sitename
      */
     protected function loadDefaultEnvFromSitename($sitename)
     {
@@ -219,8 +221,8 @@ 
     /**
      * @param array $siteData list of sites with its respective data
      *
-     * @param SiteAliasName $aliasName The name of the record being created
      * @param $siteData An associative array of envrionment => site data
+     * @param string $sitename
      * @return SiteAlias[]
      */
     protected function createSiteAliassFromSiteData($sitename, $siteData, $location = '')
@@ -386,7 +388,7 @@ 
     /**
      * Given an array of site aliases, find the first one that is
      * local (has no 'host' item) and also contains a 'self.site.yml' file.
-     * @param array $data
+     * @param string $path
      * @return array
      */
     protected function findSelfSiteAliases($site_aliases, $path)
@@ -450,6 +452,9 @@ 
         return $this->loader[$extension];
     }
 
+    /**
+     * @param string $extension
+     */
     public function addLoader($extension, DataFileLoaderInterface $loader)
     {
         $this->loader[$extension] = $loader;