Browse Source

[Console] Add missing method isInteractive() to InputInterface and added some docblock comments to all interface methods.

Benjamin Eberlei 14 years ago
parent
commit
6ac5c298bd
1 changed files with 27 additions and 0 deletions
  1. 27 0
      src/Symfony/Component/Console/Input/InputInterface.php

+ 27 - 0
src/Symfony/Component/Console/Input/InputInterface.php

@@ -44,13 +44,40 @@ interface InputInterface
      */
     function bind(InputDefinition $definition);
 
+    /**
+     * Validate if arguments given are correct.
+     *
+     * Throws an exception when not enough arguments are given.
+     *
+     * @throws \RuntimeException
+     */
     function validate();
 
+    /**
+     * Returns all the given arguments merged with the default values.
+     *
+     * @return array
+     */
     function getArguments();
 
+    /**
+     * Get argument by name.
+     *
+     * @return mixed
+     */
     function getArgument($name);
 
+    /**
+     * @return array
+     */
     function getOptions();
 
     function getOption($name);
+
+    /**
+     * Is this input means interactive?
+     *
+     * @return bool
+     */
+    function isInteractive();
 }