소스 검색

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

Benjamin Eberlei 14 년 전
부모
커밋
6ac5c298bd
1개의 변경된 파일27개의 추가작업 그리고 0개의 파일을 삭제
  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);
     function bind(InputDefinition $definition);
 
 
+    /**
+     * Validate if arguments given are correct.
+     *
+     * Throws an exception when not enough arguments are given.
+     *
+     * @throws \RuntimeException
+     */
     function validate();
     function validate();
 
 
+    /**
+     * Returns all the given arguments merged with the default values.
+     *
+     * @return array
+     */
     function getArguments();
     function getArguments();
 
 
+    /**
+     * Get argument by name.
+     *
+     * @return mixed
+     */
     function getArgument($name);
     function getArgument($name);
 
 
+    /**
+     * @return array
+     */
     function getOptions();
     function getOptions();
 
 
     function getOption($name);
     function getOption($name);
+
+    /**
+     * Is this input means interactive?
+     *
+     * @return bool
+     */
+    function isInteractive();
 }
 }