StdinHandler

StdinHandler is a thin wrapper around php://stdin. It provides methods for redirecting input from a file, possibly conditionally under the control of an Input object.

Example trivial usage (always reads from stdin):

 class Example implements StdinAwareInterface
 {
     /**
      * @command cat
      * @param string $file
      * @default $file -
      * /
     public function cat()
     {
          print($this->stdin()->contents());
     }
 }

Command that reads from stdin or file via an option:

 /**
  * @command cat
  * @param string $file
  * @default $file -
  * /
 public function cat(InputInterface $input)
 {
     $data = $this->stdin()->select($input, 'file')->contents();
 }

Command that reads from stdin or file via an option:

 /**
  * @command cat
  * @option string $file
  * @default $file -
  * /
 public function cat(InputInterface $input)
 {
     $data = $this->stdin()->select($input, 'file')->contents();
 }

It is also possible to inject the selected stream into the input object, e.g. if you want the contents of the source file to be fed to any Question helper et. al. that the $input object is used with.

 /**
  * @command example
  * @option string $file
  * @default $file -
  * /
 public function example(InputInterface $input)
 {
     $this->stdin()->setStream($input, 'file');
 }

Inject an alternate source for standard input in tests. Presumes that the object under test gets a reference to the StdinHandler via dependency injection from the container.

 $container->get('stdinHandler')->redirect($pathToTestStdinFileFixture);

You may also inject your stdin file fixture stream into the $input object as usual, and then use it with 'select()' or 'setStream()' as shown above.

Finally, this class may also be used in absence of a dependency injection container by using the static 'selectStream()' method:

 /**
  * @command example
  * @option string $file
  * @default $file -
  * /
 public function example(InputInterface $input)
 {
     $data = StdinHandler::selectStream($input, 'file')->contents();
 }

To test a method that uses this technique, simply inject your stdin fixture into the $input object in your test:

 $input->setStream(fopen($pathToFixture, 'r'));