(PHP 4, PHP 5, PHP 7, PHP 8)
clearstatcache — Очищает кеш состояния файлов
Чтобы повысить производительность при вызове функций stat(), lstat() или любой другой функции из списка, который приводит эта страница, PHP кеширует результаты выполнения этих функций. Однако иногда требуется очистка этого кеша. Например, когда скрипт несколько раз проверяет состояние одного и того же файла, который может быть изменён или удалён во время выполнения скрипта, может потребоваться очистка кеша состояния. Тогда для очистки в PHP кешированной информации о файле вызывают функцию clearstatcache().
Обратите внимание, что PHP не кеширует информацию о несуществующих
файлах. Поэтому, если вызывать функцию file_exists()
на несуществующем файле, функция будет возвращать false до тех пор, пока
вы не создадите этот файл. Если же вы создадите файл, функция будет
возвращать true, даже если затем вы удалите файл. Однако функция
unlink() очистит этот кеш автоматически.
Замечание:
Эта функция кеширует информацию об отдельных файлах, поэтому имеет смысл вызывать функцию clearstatcache(), только если вы совершаете несколько операций с одним и тем же файлом и не хотите получать кешированную информацию об этом файле.
Список функций, результаты выполнения которых кешируются: stat(), lstat(), file_exists(), is_writable(), is_readable(), is_executable(), is_file(), is_dir(), is_link(), filectime(), fileatime(), filemtime(), fileinode(), filegroup(), fileowner(), filesize(), filetype() и fileperms().
clear_realpath_cacheНужно ли также очищать кеш realpath.
filename
Очистить кеш realpath только для определённого имени файла; используется
только в том случае, если у параметра clear_realpath_cache
установлено значение true.
Функция не возвращает значения после выполнения.
Пример #1 Пример использования функции clearstatcache()
<?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($format, date('r'), get_owner($file));
chown($file, 'ross');
printf($format, date('r'), get_owner($file));
clearstatcache();
printf($format, date('r'), get_owner($file));
?>Вывод приведённого примера будет похож на:
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
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.clearstatcache() does not canonicalize the path. clearstatcache(true, "/a/b/c") is different from clearstatcache(true, "/a/b//c").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-sessionsNote 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.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 :-( ).