aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Revision/SlotRenderingProvider.php
blob: b83f76a7aa0c865f68020cc12dac77a15b127b26 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<?php

namespace MediaWiki\Revision;

use MediaWiki\Parser\ParserOutput;

/**
 * A lazy provider of ParserOutput objects for a revision's individual slots.
 *
 * @since 1.32
 */
interface SlotRenderingProvider {

	/**
	 * @param string $role
	 * @param array $hints Hints given as an associative array. Known keys:
	 *      - 'generate-html' => bool: Whether the caller is interested in output HTML (as opposed
	 *        to just meta-data). Default is to generate HTML.
	 *
	 * @throws SuppressedDataException if the content is not accessible for the audience
	 *         specified in the constructor.
	 * @return ParserOutput
	 */
	public function getSlotParserOutput( $role, array $hints = [] );

}