[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.txt
   8   */
   9  
  10  namespace Joomla\CMS\Document;
  11  
  12  // phpcs:disable PSR1.Files.SideEffects
  13  \defined('_JEXEC') or die;
  14  // phpcs:enable PSR1.Files.SideEffects
  15  
  16  /**
  17   * Interface defining a factory which can create Document objects
  18   *
  19   * @since  4.0.0
  20   */
  21  interface FactoryInterface
  22  {
  23      /**
  24       * Creates a new Document object for the requested format.
  25       *
  26       * @param   string  $type        The document type to instantiate
  27       * @param   array   $attributes  Array of attributes
  28       *
  29       * @return  Document
  30       *
  31       * @since   4.0.0
  32       */
  33      public function createDocument(string $type = 'html', array $attributes = []): Document;
  34  
  35      /**
  36       * Creates a new renderer object.
  37       *
  38       * @param   Document  $document  The Document instance to attach to the renderer
  39       * @param   string    $type      The renderer type to instantiate
  40       * @param   string    $docType   The document type the renderer is part of
  41       *
  42       * @return  RendererInterface
  43       *
  44       * @since   4.0.0
  45       */
  46      public function createRenderer(Document $document, string $type, string $docType = ''): RendererInterface;
  47  }