update some logic, modify error handle

Author: inhere

README.md

@@ -254,7 +254,7 @@ $app->registerGroups('App\\Console\\Controllers', dirname(__DIR__) . '/Controlle
 
 ## 错误/异常捕获
 
-<img src="docs/screenshots/error-catch.jpg" alt="error-catch" style="width: 500px">
+![error-handle-display](docs/screenshots/error-handle-display.png)
 
 ## 输入
 

docs/screenshots/error-catch.jpg

@@ -129,7 +129,7 @@ public function exCommand()
      */
     public function errorCommand()
     {
-        trigger_error('oo, this is a runtime error!', E_USER_ERROR);
+        \trigger_error('oo, this is a runtime error!', E_USER_ERROR);
     }
 
     /**

docs/screenshots/error-catch.png

@@ -11,7 +11,7 @@ define('BASE_PATH', dirname(__DIR__));
 require dirname(__DIR__) . '/test/boot.php';
 
 $input = new \Inhere\Console\IO\Input();
-$ctrl = new HomeController($input, new \Inhere\Console\IO\Output());
+$ctrl  = new HomeController($input, new \Inhere\Console\IO\Output());
 $ctrl->setExecutionAlone();
 
 try {
@@ -24,15 +24,4 @@ try {
     );
 }
 
-// can also:
-
-// $app = new \Inhere\Console\Application([
-//     'debug' => true,
-//     'rootPath' => BASE_PATH,
-// ]);
-//
-// $app->controller('home', HomeController::class);
-//
-// exit(
-//     (int)$app->runAction('home', $app->getInput()->getCommand(), false, true)
-// );
+// can also: see './alone-app' file

docs/screenshots/error-handle-display.png

@@ -0,0 +1,32 @@
+#!/usr/env/php
+<?php
+/**
+ * only run a controller.
+ */
+
+use Inhere\Console\Examples\Controllers\HomeController;
+
+define('BASE_PATH', dirname(__DIR__));
+
+require dirname(__DIR__) . '/test/boot.php';
+
+try {
+    $input = new \Inhere\Console\IO\Input();
+    $app   = new \Inhere\Console\Application([
+        'debug'    => true,
+        'rootPath' => BASE_PATH,
+    ], $input);
+
+    $app->controller('home', HomeController::class);
+    $code = $app->runAction('home', $input->getCommand(), false, true);
+
+    exit((int)$code);
+} catch (\Exception $e) {
+    $message = \Toolkit\Cli\Color::apply('error', $e->getMessage());
+
+    echo sprintf("%s\nFile %s:%d\nTrace:\n%s\n",
+        $message, $e->getFile(), $e->getLine(), $e->getTraceAsString()
+    );
+}
+
+// can also: see './alone' file

examples/Controllers/HomeController.php

@@ -44,4 +44,4 @@
 $app->controller(PharController::class);
 
 // add alias for a group command.
-$app->addCommandAliases('home:test', 'h-test');
+$app->addCommandAliases('home:test', 'h-test');

examples/home renamed to examples/alone

@@ -198,6 +198,11 @@ public function addGroup(string $name, $controller = null, $option = null)
 
     /**
      * auto register commands from a dir.
+     *
+     * ```php
+     * $app->registerCommands('SwagPhp\Command', dirname(__DIR__) . '/src/Command');
+     * ```
+     *
      * @param string $namespace
      * @param string $basePath
      * @return $this

examples/alone-app

@@ -8,6 +8,8 @@
 
 namespace Inhere\Console\Base;
 
+use Inhere\Console\BuiltIn\ErrorHandler;
+use Inhere\Console\Face\ErrorHandlerInterface;
 use Inhere\Console\IO\Input;
 use Inhere\Console\IO\InputInterface;
 use Inhere\Console\IO\Output;
@@ -89,6 +91,9 @@ abstract class AbstractApplication implements ApplicationInterface
     /** @var array The group commands */
     protected $controllers = [];
 
+    /** @var ErrorHandlerInterface */
+    private $errorHandler;
+
     /**
      * App constructor.
      * @param array $meta
@@ -139,6 +144,10 @@ public static function getInternalOptions(): array
 
     protected function prepareRun()
     {
+        if (!$this->errorHandler) {
+            $this->errorHandler = new ErrorHandler();
+        }
+
         // date_default_timezone_set($this->config('timeZone', 'UTC'));
         //new AutoCompletion(array_merge($this->getCommandNames(), $this->getControllerNames()));
     }
@@ -172,7 +181,7 @@ public function run(bool $exit = true)
             $this->handleException($e);
         }
 
-        $this->meta['_stats']['endTime'] = microtime(1);
+        $this->meta['_stats']['endTime'] = \microtime(1);
 
         // call 'onAfterRun' service, if it is registered.
         $this->fire(self::ON_AFTER_RUN, $this);
@@ -255,7 +264,6 @@ protected function registerErrorHandle()
     {
         \set_error_handler([$this, 'handleError']);
         \set_exception_handler([$this, 'handleException']);
-
         \register_shutdown_function(function () {
             if ($e = \error_get_last()) {
                 $this->handleError($e['type'], $e['message'], $e['file'], $e['line']);
@@ -278,57 +286,15 @@ public function handleError(int $num, string $str, string $file, int $line)
     }
 
     /**
-     * 运行异常处理
+     * Running exception handling
      * @param \Throwable $e
      * @throws \InvalidArgumentException
      */
     public function handleException($e)
-    {
-        $class = \get_class($e);
-        $this->logError($e);
-
-        // open debug, throw exception
-        if ($this->isDebug()) {
-            $tpl = <<<ERR
-\n<error> Error </error> <mga>%s</mga>
-
-At File <cyan>%s</cyan> line <bold>%d</bold>
-Exception $class
-<comment>Code View:</comment>\n\n%s
-<comment>Code Trace:</comment>\n\n%s\n
-ERR;
-            $line = $e->getLine();
-            $file = $e->getFile();
-            $snippet = Highlighter::create()->highlightSnippet(file_get_contents($file), $line, 3, 3);
-            $message = sprintf(
-                $tpl,
-                // $e->getCode(),
-                $e->getMessage(),
-                $file,
-                $line,
-                // __METHOD__,
-                $snippet,
-                \str_replace('):', "):\n  -", $e->getTraceAsString())
-            );
-
-            if ($this->meta['hideRootPath'] && ($rootPath = $this->meta['rootPath'])) {
-                $message = \str_replace($rootPath, '{ROOT}', $message);
-            }
-
-            $this->output->write($message, false);
-        } else {
-            // simple output
-            $this->output->error('An error occurred! MESSAGE: ' . $e->getMessage());
-            $this->output->write("\nYou can use '--debug' to see error details.");
-        }
-    }
-
-    /**
-     * @param \Throwable $e
-     */
-    protected function logError($e)
     {
         // you can log error on sub class ...
+
+        $this->errorHandler->handle($e, $this);
     }
 
     /**
@@ -392,7 +358,7 @@ protected function validateName(string $name, bool $isGroup = false)
      * @param bool $quit
      * @param string $command
      */
-    public function showHelpInfo($quit = true, string $command = null)
+    public function showHelpInfo(bool $quit = true, string $command = '')
     {
         // display help for a special command
         if ($command) {
@@ -423,14 +389,14 @@ public function showHelpInfo($quit = true, string $command = null)
      */
     public function showVersionInfo($quit = true)
     {
-        $os = PHP_OS;
-        $date = date('Y.m.d');
+        $os = \PHP_OS;
+        $date = \date('Y.m.d');
         $logo = '';
         $name = $this->getMeta('name', 'Console Application');
         $version = $this->getMeta('version', 'Unknown');
         $publishAt = $this->getMeta('publishAt', 'Unknown');
         $updateAt = $this->getMeta('updateAt', 'Unknown');
-        $phpVersion = PHP_VERSION;
+        $phpVersion = \PHP_VERSION;
 
         if ($logoTxt = $this->getLogoText()) {
             $logo = Helper::wrapTag($logoTxt, $this->getLogoStyle());
@@ -462,7 +428,7 @@ public function showCommandList($quit = true)
         // all console controllers
         if ($controllers = $this->controllers) {
             \ksort($controllers);
-            $controllerArr[] = PHP_EOL . '- <bold>Group Commands</bold>';
+            $controllerArr[] = \PHP_EOL . '- <bold>Group Commands</bold>';
         }
 
         foreach ($controllers as $name => $controller) {
@@ -480,7 +446,7 @@ public function showCommandList($quit = true)
 
         // all independent commands, Independent, Single, Alone
         if ($commands = $this->commands) {
-            $commandArr[] = PHP_EOL . '- <bold>Alone Commands</bold>';
+            $commandArr[] = \PHP_EOL . '- <bold>Alone Commands</bold>';
             \ksort($commands);
         }
 
@@ -535,7 +501,7 @@ public function showCommandList($quit = true)
      * @param string $default
      * @return string|null
      */
-    public function getCommandMessage($name, $default = null)
+    public function getCommandMessage(string $name, $default = null)
     {
         return $this->commandMessages[$name] ?? $default;
     }
@@ -873,4 +839,20 @@ public function getCommandMetaValue(string $command, string $key, $default = nul
     {
         return $this->commandsMeta[$command][$key] ?? $default;
     }
+
+    /**
+     * @return ErrorHandlerInterface
+     */
+    public function getErrorHandler(): ErrorHandlerInterface
+    {
+        return $this->errorHandler;
+    }
+
+    /**
+     * @param ErrorHandlerInterface $errorHandler
+     */
+    public function setErrorHandler(ErrorHandlerInterface $errorHandler): void
+    {
+        $this->errorHandler = $errorHandler;
+    }
 }