File: IContentHandlerFactory.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (43 lines) | stat: -rw-r--r-- 1,122 bytes parent folder | download
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
<?php

namespace MediaWiki\Content;

use MWUnknownContentModelException;

interface IContentHandlerFactory {

	/**
	 * Returns a ContentHandler instance for the given $modelID.
	 *
	 * @param string $modelID
	 *
	 * @return ContentHandler
	 * @throws MWUnknownContentModelException If no handler is known for the model ID.
	 */
	public function getContentHandler( string $modelID ): ContentHandler;

	/**
	 * Returns a list of defined content models.
	 * getContentHandler() can be expected to return a ContentHandler for the models returned
	 * by this method.
	 *
	 * @return string[]
	 */
	public function getContentModels(): array;

	/**
	 * Returns a list of all serialization formats supported for any of the defined content models.
	 * @see ContentHandler::getSupportedFormats()
	 * @return string[]
	 */
	public function getAllContentFormats(): array;

	/**
	 * Returns true if $modelID is a defined content model for which getContentHandler() can be
	 * expected to return a ContentHandler instance.
	 * @param string $modelID
	 *
	 * @return bool
	 */
	public function isDefinedModel( string $modelID ): bool;
}