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 MediaWiki\Storage\SuppressedDataException;
  11 use ParserOutput;
  12
  13 /**
  14  * A lazy provider of ParserOutput objects for a revision's individual slots.
  15  *
  16  * @since 1.32
  17  */
  18 interface SlotRenderingProvider {
  19
  20         /**
  21          * @param string $role
  22          * @param array $hints Hints given as an associative array. Known keys:
  23          *      - 'generate-html' => bool: Whether the caller is interested in output HTML (as opposed
  24          *        to just meta-data). Default is to generate HTML.
  25          *
  26          * @throws SuppressedDataException if the content is not accessible for the audience
  27          *         specified in the constructor.
  28          * @return ParserOutput
  29          */
  30         public function getSlotParserOutput( $role, array $hints = [] );
  31
  32 }