[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2017 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license    GNU General Public License version 2 or later; see LICENSE
   8   */
   9  
  10  namespace Joomla\CMS\Error\Renderer;
  11  
  12  use Joomla\CMS\Error\AbstractRenderer;
  13  
  14  // phpcs:disable PSR1.Files.SideEffects
  15  \defined('JPATH_PLATFORM') or die;
  16  // phpcs:enable PSR1.Files.SideEffects
  17  
  18  /**
  19   * Cli error renderer
  20   *
  21   * @since  4.0.0
  22   */
  23  class CliRenderer extends AbstractRenderer
  24  {
  25      /**
  26       * The format (type)
  27       *
  28       * @var    string
  29       * @since  4.0.0
  30       */
  31      protected $type = 'cli';
  32  
  33      /**
  34       * Render the error for the given object.
  35       *
  36       * @param   \Throwable  $error  The error object to be rendered
  37       *
  38       * @return  string
  39       *
  40       * @since   4.0.0
  41       */
  42      public function render(\Throwable $error): string
  43      {
  44          $buffer = PHP_EOL . 'Error occurred: ' . $error->getMessage() . PHP_EOL . $this->getTrace($error);
  45  
  46          if ($prev = $error->getPrevious()) {
  47              $buffer .= PHP_EOL . PHP_EOL . 'Previous Exception: ' . $prev->getMessage() . PHP_EOL . $this->getTrace($prev);
  48          }
  49  
  50          return $buffer;
  51      }
  52  
  53      /**
  54       * Returns a trace for the given error.
  55       *
  56       * @param   \Throwable  $error  The error
  57       *
  58       * @return  string
  59       *
  60       * @since   4.0.0
  61       */
  62      private function getTrace(\Throwable $error): string
  63      {
  64          // Include the stack trace only if in debug mode
  65          if (!JDEBUG) {
  66              return '';
  67          }
  68  
  69          return PHP_EOL . $error->getTraceAsString() . PHP_EOL;
  70      }
  71  }