File: SettingsFormat.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 (35 lines) | stat: -rw-r--r-- 770 bytes parent folder | download | duplicates (3)
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
<?php

namespace MediaWiki\Settings\Source\Format;

use Stringable;
use UnexpectedValueException;

/**
 * A SettingsFormat is meant to detect supported file types and/or decode
 * source contents into settings arrays.
 *
 * @since 1.38
 * @stable to implement
 */
interface SettingsFormat extends Stringable {
	/**
	 * Decodes the given settings data and returns an associative array.
	 *
	 * @param string $data Settings data.
	 *
	 * @return array
	 * @throws UnexpectedValueException
	 */
	public function decode( string $data ): array;

	/**
	 * Whether or not the format claims to support a file with the given
	 * extension.
	 *
	 * @param string $ext File extension.
	 *
	 * @return bool
	 */
	public static function supportsFileExtension( string $ext ): bool;
}