[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2005 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;
  11  
  12  use Joomla\CMS\Document\Document;
  13  
  14  // phpcs:disable PSR1.Files.SideEffects
  15  \defined('JPATH_PLATFORM') or die;
  16  // phpcs:enable PSR1.Files.SideEffects
  17  
  18  /**
  19   * Interface defining the rendering engine for the error handling layer
  20   *
  21   * @since  4.0.0
  22   */
  23  interface RendererInterface
  24  {
  25      /**
  26       * Retrieve the Document instance attached to this renderer
  27       *
  28       * @return  Document
  29       *
  30       * @since   4.0.0
  31       */
  32      public function getDocument(): Document;
  33  
  34      /**
  35       * Render the error page for the given object
  36       *
  37       * @param   \Throwable  $error  The error object to be rendered
  38       *
  39       * @return  string
  40       *
  41       * @since   4.0.0
  42       */
  43      public function render(\Throwable $error): string;
  44  }