clearstatcache

(PHP 4, PHP 5, PHP 7, PHP 8)

clearstatcacheLöscht den Status-Cache

Beschreibung

clearstatcache(bool $clear_realpath_cache = false, string $filename = ""): void

Wenn stat(), lstat() oder eine andere der in der nachstehenden Liste aufgeführten betroffenen Funktionen verwendet wird, speichert (cached) PHP die von diesen Funktionen zurückgegebenen Informationen temporär, um eine bessere Performance zu bieten. In bestimmten Fällen kann es jedoch erforderlich sein, diese zwischengespeicherten Informationen zu löschen. Wird z. B. dieselbe Datei innerhalb eines Skriptes mehrmals geprüft und wird diese Datei möglicherweise während der Ausführung des Skriptes gelöscht oder verändert, könnte es sinnvoll sein, den Status-Cache zu löschen. In solchen Fällen empfiehlt es sich, die von PHP über eine Datei zwischengespeicherten Informationen mittels clearstatcache() zu löschen.

Zu beachten ist auch, dass PHP die Informationen über nicht existente Dateien nicht zwischenspeichert. Falls also file_exists() für eine Datei aufgerufen wird, die nicht existiert, wird false zurückgegeben, bis sie erzeugt wird. Wenn die Datei erzeugt wurde, wird true zurückgegeben, auch wenn die Datei danach gelöscht wird. unlink() leert den Zwischenspeicher jedoch automatisch.

Hinweis:

Diese Funktion speichert Informationen über bestimmte Dateinamen, weshalb clearstatcache() nur aufgerufen werden muss, wenn mehrere Operationen an demselben Dateinamen durchgeführt werden, und die Informationen über genau diese Datei nicht gespeichert werden sollen.

Betroffene Funktionen sind stat(), lstat(), file_exists(), is_writable(), is_readable(), is_executable(), is_file(), is_dir(), is_link(), filectime(), fileatime(), filemtime(), fileinode(), filegroup(), fileowner(), filesize(), filetype() und fileperms().

Parameter-Liste

clear_realpath_cache

Ob der realpath-Zwischenspeicher ebenfalls geleert werden soll.

filename

Leere den realpath- und den Stat-Zwischenspeicher nur für einen bestimmten Dateinamen; wird nur genutzt, wenn clear_realpath_cache true ist.

Rückgabewerte

Es wird kein Wert zurückgegeben.

Beispiele

Beispiel #1 clearstatcache()-Beispiel

<?php
$file 
'output_log.txt';

function 
get_owner($file)
{
    
$stat stat($file);
    
$user posix_getpwuid($stat['uid']);
    return 
$user['name'];
}

$format "UID @ %s: %s\n";

printf($formatdate('r'), get_owner($file));

chown($file'ross');
printf($formatdate('r'), get_owner($file));

clearstatcache();
printf($formatdate('r'), get_owner($file));
?>

Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:

UID @ Sun, 12 Oct 2008 20:48:28 +0100: root
UID @ Sun, 12 Oct 2008 20:48:28 +0100: root
UID @ Sun, 12 Oct 2008 20:48:28 +0100: ross

add a note

User Contributed Notes 7 notes

up
5
vechenjivot at gmail dot com
2 years ago
Not documented, but seems like clearstatcache() is clearing the cache only for the process it is being called from. I have 2 PHP scripts running simultaneously, and the first one does call clearstatcache(), but still the second one deadlocks, unless I call clearstatcache() in it too:

script1:
<?php
    touch
('system.lock');
    ...
   
unlink('system.lock');
   
clearstatcache(); // should be done by unlink?
?>

script2:
<?php
   
while (is_file('system.lock') {
       
sleep(1);
       
clearstatcache(); // without this, script 2 will deadlock forever!
   
}
?>

I also found this page, which leads to the same conclusion:
https://stackoverflow.com/questions/9251237/clearstatcache-include-path-sessions
up
37
matt_m at me dot com
10 years ago
unlink() does not clear the cache if you are performing file_exists() on a remote file like:

<?php
if (file_exists("ftp://ftp.example.com/somefile"))
?>

In this case, even after you unlink() successfully, you must call clearstatcache().

<?php
unlink
("ftp://ftp.example.com/somefile");
clearstatcache();
?>

file_exists() then properly returns false.
up
10
msaladna at apisnetworks dot com
2 years ago
clearstatcache() does not canonicalize the path. clearstatcache(true, "/a/b/c") is different from clearstatcache(true, "/a/b//c").
up
5
David Spector
3 years ago
Note that this function affects only file metadata. However, all the PHP file system functions do their own caching of actual file contents as well. You can use the "realpath_cache_size = 0" directive in PHP.ini to disable the content caching if you like. The default content caching timeout is 120 seconds.

Content caching is not a good idea during development work and for certain kinds of applications, since your code may read in old data from a file whose contents you have just changed.

Note: This is separate from the caching typically done by browsers for all GET requests (the majority of Web accesses) unless the HTTP headers override it. It is also separate from optional Apache server caching.
up
8
bj at wjblack dot com
7 years ago
Just to make this more obvious (and so search engines find this easier):

If you do fileops of any kind outside of PHP (say via a system() call), you probably want to clear the stat cache before doing any further tests on the file/dir/whatever.  For example:

<?php
// is_dir() forces a stat call, so the cache is populated
if( is_dir($foo) ) {
   
system("rm -rf " . escapeshellarg($foo));
    if(
is_dir($foo) ) {
       
// ...will still be true, even if the rm succeeded, because it's just
        // reading from cache, not re-running the stat()
   
}
}
?>

Pop a clearstatcache() after the system call and all is good (modulo a bit of a performance hit from having a cleared stat cache :-( ).
up
1
Gabriel
3 years ago
Definition of $filename parameter let's you think that it expects the filename only but it works if you give the path + filename also.

It should be more clear about this.
up
-35
markandrewslade at gmail dot com
12 years ago
On Linux, a forked process inherits a copy of the parent's cache, but after forking the two caches do not impact each other.  The snippet below demonstrates this by creating a child and confirming outdated (cached) information, then clearing the cache, and getting new information.

<?php

function report($directory, $prefix = '') { printf('%sDoes %s exist?  PHP says "%s"'. PHP_EOL, $prefix, $directory, is_dir($directory) ? 'yes' : 'no'); }
$target = './delete-me-before-running-statcache';

if (
is_dir($target)) {
    die(
"Delete $target before running.\n");
}

echo
"Creating $target.\n";
mkdir($target) || die("Unable to create $target.\n");
report($target); // is_dir($target) is now cached as true

echo "Unlinking $target.\n";
rmdir($target) || die("Unable to unlink $target.\n");

// This will say "yes", which is old (inaccurate) information.
report($target);

if ((
$pid = pcntl_fork()) === -1) { die("Failed to pcntl_fork.\n"); }
elseif (
$pid === 0) {
   
// child
   
report($target, '<<child>> ');
    echo
"<<child>> Clearing stat cache.\n";
   
clearstatcache();
   
report($target, '<<child>> ');
} else {
   
// parent
   
sleep(2); // move this to the child block to reverse the test.
   
report($target, '<<<parent>> ');
   
clearstatcache();
   
report($target, '<<<parent>> ');
}

?>
To Top