Chris@17: <?php
Chris@17: namespace Consolidation\AnnotatedCommand;
Chris@17: 
Chris@17: /**
Chris@17:  * Return a CommandResult as the result of a command to pass both an exit
Chris@17:  * code and result data from a command.
Chris@17:  *
Chris@17:  * Usage:
Chris@17:  *
Chris@17:  *      return CommandResult::dataWithExitCode(new RowsOfFields($rows), 1);
Chris@17:  *
Chris@17:  * The CommandResult can also be used to unambiguously return just
Chris@17:  * an exit code or just output data.
Chris@17:  *
Chris@17:  * Exit code only:
Chris@17:  *
Chris@17:  *      return CommandResult::dataWithExitCode(1);
Chris@17:  *
Chris@17:  * Data only:
Chris@17:  *
Chris@17:  *      return CommandResult::data(new RowsOfFields($rows));
Chris@17:  *
Chris@17:  * Historically, it has always been possible to return an integer to indicate
Chris@17:  * that the result is an exit code, and other return types (typically array
Chris@17:  * / ArrayObjects) indicating actual data with an implicit exit code of 0.
Chris@17:  * Using a CommandResult is preferred, though, as it allows the result of the
Chris@17:  * function to be unambiguously specified without type-based interpretation.
Chris@17:  *
Chris@17:  * @package Consolidation\AnnotatedCommand
Chris@17:  */
Chris@17: class CommandResult implements ExitCodeInterface, OutputDataInterface
Chris@17: {
Chris@17:     protected $data;
Chris@17:     protected $exitCode;
Chris@17: 
Chris@17:     protected function __construct($data = null, $exitCode = 0)
Chris@17:     {
Chris@17:         $this->data = $data;
Chris@17:         $this->exitCode = $exitCode;
Chris@17:     }
Chris@17: 
Chris@17:     public static function exitCode($exitCode)
Chris@17:     {
Chris@17:         return new self(null, $exitCode);
Chris@17:     }
Chris@17: 
Chris@17:     public static function data($data)
Chris@17:     {
Chris@17:         return new self($data);
Chris@17:     }
Chris@17: 
Chris@17:     public static function dataWithExitCode($data, $exitCode)
Chris@17:     {
Chris@17:         return new self($data, $exitCode);
Chris@17:     }
Chris@17: 
Chris@17:     public function getExitCode()
Chris@17:     {
Chris@17:         return $this->exitCode;
Chris@17:     }
Chris@17: 
Chris@17:     public function getOutputData()
Chris@17:     {
Chris@17:         return $this->data;
Chris@17:     }
Chris@17: 
Chris@17:     public function setOutputData($data)
Chris@17:     {
Chris@17:         $this->data = $data;
Chris@17:     }
Chris@17: }