Chris@13: <?php
Chris@13: 
Chris@13: /*
Chris@13:  * This file is part of Psy Shell.
Chris@13:  *
Chris@13:  * (c) 2012-2018 Justin Hileman
Chris@13:  *
Chris@13:  * For the full copyright and license information, please view the LICENSE
Chris@13:  * file that was distributed with this source code.
Chris@13:  */
Chris@13: 
Chris@13: namespace Psy\Exception;
Chris@13: 
Chris@13: /**
Chris@13:  * A break exception, used for halting the Psy Shell.
Chris@13:  */
Chris@13: class BreakException extends \Exception implements Exception
Chris@13: {
Chris@13:     private $rawMessage;
Chris@13: 
Chris@13:     /**
Chris@13:      * {@inheritdoc}
Chris@13:      */
Chris@13:     public function __construct($message = '', $code = 0, \Exception $previous = null)
Chris@13:     {
Chris@13:         $this->rawMessage = $message;
Chris@17:         parent::__construct(\sprintf('Exit:  %s', $message), $code, $previous);
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Return a raw (unformatted) version of the error message.
Chris@13:      *
Chris@13:      * @return string
Chris@13:      */
Chris@13:     public function getRawMessage()
Chris@13:     {
Chris@13:         return $this->rawMessage;
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Throws BreakException.
Chris@13:      *
Chris@13:      * Since `throw` can not be inserted into arbitrary expressions, it wraps with function call.
Chris@13:      *
Chris@13:      * @throws BreakException
Chris@13:      */
Chris@13:     public static function exitShell()
Chris@13:     {
Chris@13:         throw new self('Goodbye');
Chris@13:     }
Chris@13: }