File: ParserCacheMetadata.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 (44 lines) | stat: -rw-r--r-- 1,211 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
36
37
38
39
40
41
42
43
44
<?php

namespace MediaWiki\Parser;

/**
 * Read-only interface for metadata about a ParserCache entry.
 * @since 1.36
 */
interface ParserCacheMetadata {

	/**
	 * Returns the timestamp when the output was cached
	 * or -1 for uncacheable for legacy reasons.
	 * @todo remove legacy -1
	 *
	 * @return string|int TS_MW timestamp
	 */
	public function getCacheTime();

	/**
	 * @return int|null Revision id, if any was set
	 */
	public function getCacheRevisionId(): ?int;

	/**
	 * Returns the number of seconds after which this object should expire.
	 * This method is used by ParserCache to determine how long the ParserOutput can be cached.
	 * The timestamp of expiry can be calculated by adding getCacheExpiry() to getCacheTime().
	 * The value returned by getCacheExpiry is smaller or equal to the smallest number
	 * that was provided to a call of ParserOutput::updateCacheExpiry(),
	 * and smaller or equal to the value of $wgParserCacheExpireTime.
	 *
	 * @return int
	 */
	public function getCacheExpiry(): int;

	/**
	 * Returns the options from its ParserOptions which have been taken
	 * into account to produce the output.
	 *
	 * @return string[]
	 */
	public function getUsedOptions(): array;
}