Go to the documentation of this file.
69 if ( $this->mFilePath !==
null ) {
74 # Build directories (methods include the trailing "/")
76 # Avoid extension confusion
77 $key = str_replace(
'.',
'%2E', urlencode( $this->mKey ) );
78 # Build the full file path
79 $this->mFilePath =
"{$dir}/{$subDirs}{$key}.{$this->mExt}";
81 $this->mFilePath .=
'.gz';
92 if ( $this->mCached ===
null ) {
93 $this->mCached = file_exists( $this->
cachePath() );
104 $timestamp = filemtime( $this->
cachePath() );
106 return ( $timestamp !==
false )
125 $good = ( $timestamp <= $cachetime &&
$wgCacheEpoch <= $cachetime );
127 ": cachetime $cachetime, touched '{$timestamp}' epoch {$wgCacheEpoch}, good $good\n" );
146 $fh = gzopen( $this->
cachePath(),
'rb' );
148 return stream_get_contents( $fh );
150 return file_get_contents( $this->
cachePath() );
161 $text = gzencode( $text );
165 if ( !file_put_contents( $this->
cachePath(), $text, LOCK_EX ) ) {
167 $this->mCached =
null;
172 $this->mCached =
true;
182 MediaWiki\suppressWarnings();
184 MediaWiki\restoreWarnings();
185 $this->mCached =
false;
204 return $this->mType .
'/';
217 $hash = md5( $this->mKey );
219 $subdir .= substr( $hash, 0, $i ) .
'/';
232 if ( mt_rand( 0, self::MISS_FACTOR - 1 ) == 0 ) {
234 # Get a large IP range that should include the user even if that
235 # person's IP address changes
244 # Bail out if a request already came from this range...
246 if (
$cache->get( $key ) ) {
249 $cache->set( $key, 1, self::MISS_TTL_SEC );
251 # Increment the number of cache misses...
254 $cache->set( $key, 1, self::MISS_TTL_SEC );
cacheMissKey(BagOStuff $cache)
processing should stop and the error should be shown to the user * false
static getLocalClusterInstance()
Get the main cluster-local cache object.
saveText( $text)
Save and compress text to the cache.
isCacheGood( $timestamp='')
Check if up to date cache file exists.
wfMkdirParents( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don't exist.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
interface is intended to be more or less compatible with the PHP memcached client.
static isIPv6( $ip)
Given a string, determine if it as valid IP in IPv6 only.
hashSubdirectory()
Return relative multi-level hash subdirectory (with trailing slash) or the empty string if not $wgFil...
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
useGzip()
Check if the cache is gzipped.
baseCacheDirectory()
Get the base file cache directory.
$wgUseGzip
When using the file cache, we can store the cached HTML gzipped to save disk space.
when a variable name is used in a it is silently declared as a new masking the global
fetchText()
Get the uncompressed text from the cache.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
typeSubdirectory()
Get the cache type subdirectory (with trailing slash) An extending class could use that method to alt...
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
$wgFileCacheDepth
Depth of the subdirectory hierarchy to be created under $wgFileCacheDirectory.
isCached()
Check if the cache file exists.
cacheDirectory()
Get the base cache directory (not specific to this file)
clearCache()
Clear the cache for this page.
static isValid( $ip)
Validate an IP address.
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
$wgCacheEpoch
Set this to current time to invalidate all prior cached pages.
getMissesRecent()
Roughly gets the cache misses in the last hour by unique visitors.
cachePath()
Get the path to the cache file.
$wgFileCacheDirectory
Directory where the cached page will be saved.
incrMissesRecent(WebRequest $request)
Roughly increments the cache misses in the last hour by unique visitors.
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
static sanitizeRange( $range)
Gets rid of unneeded numbers in quad-dotted/octet IP strings For example, 127.111....
cacheTimestamp()
Get the last-modified timestamp of the cache file.
checkCacheDirs()
Create parent directors of $this->cachePath()
Base class for data storage in the file system.