consolidation / annotated-command

src/Hooks/HookManager.php

Spacing +1 added lines, -1 removed lines

@@ -255,7 +255,7 @@
     {
         $names = array_merge(
             (array)$names,
-            ($annotationData == null) ? [] : array_map(function ($item) {
+            ($annotationData == null) ? [] : array_map(function($item) {
                 return "@$item";
             }, $annotationData->keys())
         );

Doc Comments +39 added lines, -1 removed lines

@@ -64,7 +64,7 @@ 
     /**
      * Add a hook
      *
-     * @param mixed $callback The callback function to call
+     * @param callable $callback The callback function to call
      * @param string   $hook     The name of the hook to add
      * @param string   $name     The name of the command to hook
      *   ('*' for all)
@@ -78,12 +78,18 @@ 
         return $this;
     }
 
+    /**
+     * @param \Consolidation\AnnotatedCommand\Parser\CommandInfo $commandInfo
+     */
     public function recordHookOptions($commandInfo, $name)
     {
         $this->hookOptions[$name][] = $commandInfo;
         return $this;
     }
 
+    /**
+     * @param \Consolidation\AnnotatedCommand\AnnotatedCommand $command
+     */
     public static function getNames($command, $callback)
     {
         return array_filter(
@@ -306,6 +312,9 @@ 
         $command->optionsHookForHookAnnotations($commandInfoList);
     }
 
+    /**
+     * @param \Consolidation\AnnotatedCommand\AnnotatedCommand $command
+     */
     public function getHookOptionsForCommand($command)
     {
         $names = $this->addWildcardHooksToNames($command->getNames(), $command->getAnnotationData());
@@ -417,6 +426,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string[] $names
+     */
     protected function getCommandEventHooks($names)
     {
         return $this->getHooks(
@@ -537,6 +549,7 @@ 
      *
      * @param string|array $names The name of the function being hooked.
      * @param string[] $hooks A list of hooks (e.g. [HookManager::ALTER_RESULT])
+     * @param AnnotationData $annotationData
      *
      * @return callable[]
      */
@@ -592,6 +605,10 @@ 
         return [];
     }
 
+    /**
+     * @param callable $provider
+     * @param InputInterface $input
+     */
     protected function callInjectConfigurationHook($provider, $input, AnnotationData $annotationData)
     {
         if ($provider instanceof InitializeHookInterface) {
@@ -602,6 +619,10 @@ 
         }
     }
 
+    /**
+     * @param callable $optionHook
+     * @param \Consolidation\AnnotatedCommand\AnnotatedCommand $command
+     */
     protected function callOptionHook($optionHook, $command, AnnotationData $annotationData)
     {
         if ($optionHook instanceof OptionHookInterface) {
@@ -612,6 +633,11 @@ 
         }
     }
 
+    /**
+     * @param callable $interactor
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     */
     protected function callInteractor($interactor, $input, $output, AnnotationData $annotationData)
     {
         if ($interactor instanceof InteractorInterface) {
@@ -622,6 +648,9 @@ 
         }
     }
 
+    /**
+     * @param callable $validator
+     */
     protected function callValidator($validator, CommandData $commandData)
     {
         if ($validator instanceof ValidatorInterface) {
@@ -632,6 +661,9 @@ 
         }
     }
 
+    /**
+     * @param callable $processor
+     */
     protected function callProcessor($processor, $result, CommandData $commandData)
     {
         $processed = null;
@@ -647,6 +679,9 @@ 
         return $result;
     }
 
+    /**
+     * @param callable $determiner
+     */
     protected function callDeterminer($determiner, $result)
     {
         if ($determiner instanceof StatusDeterminerInterface) {
@@ -657,6 +692,9 @@ 
         }
     }
 
+    /**
+     * @param callable $extractor
+     */
     protected function callExtractor($extractor, $result)
     {
         if ($extractor instanceof ExtractOutputInterface) {

src/AnnotatedCommandFactory.php

Doc Comments +4 added lines

@@ -231,6 +231,10 @@
         }
     }
 
+    /**
+     * @param string $string
+     * @param integer $n
+     */
     protected function getNthWord($string, $n, $default = '', $delimiter = ' ')
     {
         $words = explode($delimiter, $string);

Spacing +3 added lines, -3 removed lines

@@ -178,7 +178,7 @@ 
             return [];
         }
         $className = get_class($commandFileInstance);
-        $cache_data = (array) $this->getDataStore()->get($className);
+        $cache_data = (array)$this->getDataStore()->get($className);
         if (!$cache_data) {
             return [];
         }
@@ -232,7 +232,7 @@ 
         // can never be commands.
         $commandMethodNames = array_filter(
             get_class_methods($classNameOrInstance) ?: [],
-            function ($m) {
+            function($m) {
                 return !preg_match('#^_#', $m);
             }
         );
@@ -258,7 +258,7 @@ 
         return $this->createSelectedCommandsFromClassInfo(
             $commandInfoList,
             $commandFileInstance,
-            function ($commandInfo) use ($includeAllPublicMethods) {
+            function($commandInfo) use ($includeAllPublicMethods) {
                 return static::isCommandMethod($commandInfo, $includeAllPublicMethods);
             }
         );

src/Parser/Internal/AbstractCommandDocBlockParser.php

Doc Comments +2 added lines

@@ -207,6 +207,7 @@ 
     /**
      * Given a docblock description in the form "$variable description",
      * return the variable name and description via the 'match' parameter.
+     * @param string $source
      */
     protected function pregMatchNameAndDescription($source, &$match)
     {
@@ -220,6 +221,7 @@ 
     /**
      * Given a docblock description in the form "$variable description",
      * return the variable name and description via the 'match' parameter.
+     * @param string $source
      */
     protected function pregMatchOptionNameAndDescription($source, &$match)
     {

src/AnnotatedCommand.php

Doc Comments +19 added lines

@@ -38,6 +38,9 @@ 
     protected $usesOutputInterface;
     protected $returnType;
 
+    /**
+     * @param string $name
+     */
     public function __construct($name = null)
     {
         $commandInfo = false;
@@ -67,6 +70,9 @@ 
         return $this;
     }
 
+    /**
+     * @param CommandProcessor $commandProcessor
+     */
     public function setCommandProcessor($commandProcessor)
     {
         $this->commandProcessor = $commandProcessor;
@@ -120,6 +126,9 @@ 
         return $this;
     }
 
+    /**
+     * @param CommandInfo $commandInfo
+     */
     public function setCommandInfo($commandInfo)
     {
         $this->setDescription($commandInfo->getDescription());
@@ -198,6 +207,10 @@ 
         return $dom;
     }
 
+    /**
+     * @param \DOMDocument $dom
+     * @param string $tagName
+     */
     protected function getSingleElementByTagName($dom, $parent, $tagName)
     {
         // There should always be exactly one '<command>' element.
@@ -275,6 +288,9 @@ 
         return InputArgument::OPTIONAL;
     }
 
+    /**
+     * @param CommandInfo $commandInfo
+     */
     public function setCommandOptions($commandInfo, $automaticOptions = [])
     {
         $inputOptions = $commandInfo->inputOptions();
@@ -345,6 +361,9 @@ 
         );
     }
 
+    /**
+     * @param Hooks\CommandInfo[] $commandInfoList
+     */
     public function optionsHookForHookAnnotations($commandInfoList)
     {
         foreach ($commandInfoList as $commandInfo) {

src/Parser/CommandInfo.php

Doc Comments +9 added lines, -3 removed lines

@@ -144,6 +144,9 @@ 
         return filemtime($path) != $cache['mtime'];
     }
 
+    /**
+     * @param string $methodName
+     */
     protected function constructFromClassAndMethod($classNameOrInstance, $methodName)
     {
         $this->otherAnnotations = new AnnotationData();
@@ -462,7 +465,7 @@ 
     /**
      * Set aliases that can be used in place of the command's primary name.
      *
-     * @param string|string[] $aliases
+     * @param string $aliases
      */
     public function setAliases($aliases)
     {
@@ -516,7 +519,7 @@ 
     /**
      * Return the list of refleaction parameters.
      *
-     * @return ReflectionParameter[]
+     * @return \ReflectionParameter[]
      */
     public function getParameters()
     {
@@ -647,7 +650,7 @@ 
      * Examine the parameters of the method for this command, and
      * build a list of commandline arguements for them.
      *
-     * @return array
+     * @return DefaultsWithDescriptions
      */
     protected function determineAgumentClassifications()
     {
@@ -667,6 +670,7 @@ 
      * Examine the provided parameter, and determine whether it
      * is a parameter that will be filled in with a positional
      * commandline argument.
+     * @param DefaultsWithDescriptions $result
      */
     protected function addParameterToResult($result, $param)
     {
@@ -757,6 +761,8 @@ 
     /**
      * Given a list that might be 'a b c' or 'a, b, c' or 'a,b,c',
      * convert the data into the last of these forms.
+     * @param string $text
+     * @return string
      */
     protected static function convertListToCommaSeparated($text)
     {

Spacing +4 added lines, -4 removed lines

@@ -160,7 +160,7 @@ 
 
         $this->name = $info_array['name'];
         $this->methodName = $info_array['method_name'];
-        $this->otherAnnotations = new AnnotationData((array) $info_array['annotations']);
+        $this->otherAnnotations = new AnnotationData((array)$info_array['annotations']);
         $this->arguments = new DefaultsWithDescriptions();
         $this->options = new DefaultsWithDescriptions();
         $this->aliases = $info_array['aliases'];
@@ -186,7 +186,7 @@ 
 
         $this->input_options = [];
         foreach ((array)$info_array['input_options'] as $i => $option) {
-            $option = (array) $option;
+            $option = (array)$option;
             $this->inputOptions[$i] = new InputOption(
                 $option['name'],
                 $option['shortcut'],
@@ -734,8 +734,8 @@ 
      */
     protected function convertName($camel)
     {
-        $splitter="-";
-        $camel=preg_replace('/(?!^)[[:upper:]][[:lower:]]/', '$0', preg_replace('/(?!^)[[:upper:]]+/', $splitter.'$0', $camel));
+        $splitter = "-";
+        $camel = preg_replace('/(?!^)[[:upper:]][[:lower:]]/', '$0', preg_replace('/(?!^)[[:upper:]]+/', $splitter.'$0', $camel));
         $camel = preg_replace("/$splitter/", ':', $camel, 1);
         return strtolower($camel);
     }

src/CommandFileDiscovery.php

Spacing +4 added lines, -4 removed lines

@@ -247,7 +247,7 @@ 
      */
     protected function getSearchDepth()
     {
-        return $this->searchDepth <= 0 ? '== 0' : '<= ' . $this->searchDepth;
+        return $this->searchDepth <= 0 ? '== 0' : '<= '.$this->searchDepth;
     }
 
     /**
@@ -341,7 +341,7 @@ 
         return $this->joinParts(
             '\\',
             $namespaceParts,
-            function ($item) {
+            function($item) {
                 return !is_numeric($item) && !empty($item);
             }
         );
@@ -360,7 +360,7 @@ 
         $path = $this->joinParts(
             '/',
             $pathParts,
-            function ($item) {
+            function($item) {
                 return !empty($item);
             }
         );
@@ -377,7 +377,7 @@ 
     protected function joinParts($delimiter, $parts, $filterFunction)
     {
         $parts = array_map(
-            function ($item) use ($delimiter) {
+            function($item) use ($delimiter) {
                 return rtrim($item, $delimiter);
             },
             $parts

src/CommandData.php

Doc Comments +5 added lines, -1 removed lines

@@ -39,7 +39,7 @@ 
     /**
      * For internal use only; indicates that the function to be called
      * should be passed an InputInterface &/or an OutputInterface.
-     * @param booean $usesInputInterface
+     * @param boolean $usesInputInterface
      * @param boolean $usesOutputInterface
      * @return self
      */
@@ -87,6 +87,10 @@ 
 
     // TODO: This should be a required constructor argument, but
     // implementing it this way to maintain backwards compatibility.
+
+    /**
+     * @param string $filePath
+     */
     public function setFilePath($filePath)
     {
         $this->filePath = $filePath;