includes/Revision/SlotRenderingProvider.php

   1 <?php
   2 /**
   3  * Created by PhpStorm.
   4  * User: daki
   5  * Date: 05.09.18
   6  * Time: 16:08
   7  */
   8 namespace MediaWiki\Revision;
   9
  10 use ParserOutput;
  11
  12 /**
  13  * A lazy provider of ParserOutput objects for a revision's individual slots.
  14  *
  15  * @since 1.32
  16  */
  17 interface SlotRenderingProvider {
  18
  19         /**
  20          * @param string $role
  21          * @param array $hints Hints given as an associative array. Known keys:
  22          *      - 'generate-html' => bool: Whether the caller is interested in output HTML (as opposed
  23          *        to just meta-data). Default is to generate HTML.
  24          *
  25          * @throws SuppressedDataException if the content is not accessible for the audience
  26          *         specified in the constructor.
  27          * @return ParserOutput
  28          */
  29         public function getSlotParserOutput( $role, array $hints = [] );
  30
  31 }