(PHP 4, PHP 5, PHP 7, PHP 8)
clearstatcache — Limpa o cache de estado de arquivos
Quando são chamadas as funções stat(), lstat() ou qualquer uma das funções afetadas (listadas abaixo), o PHP mantém em cache as informações que essas funções retornam para fornecer desempenho mais rápido. Entretanto, em certos casos pode ser necessário limpar as informações em cache. Por exemplo, se um mesmo arquivo é verificado várias vezes em um único script, e esse arquivo corre o risco de ser apagado ou modificado durante a operação do script, pode ser necessário limpar os dados do cache. Nesses casos, pode-se utilizar a função clearstatcache() para limpar as informações que o PHP mantém em cache sobre um arquivo.
Deve-se notar também que o PHP não guarda informação em cache sobre arquivos
não existente. Assim, a função file_exists() for chamada em um arquivo que
não existe, ela retornará false até que o arquivo seja criado. Se o arquivo
for criado, ela retornará true mesmo que o arquivo seja removido.
Entretanto, a função unlink() limpa o cache automaticamente.
Nota:
Esta função guarda infomações em cache sobre nomes de arquivos específicos, de forma que somente será necessário chamar clearstatcache() se estão sendo realizadas várias operações sobre o mesmo nome de arquivo e seja necessário que a informação sobre esse arquivo em particular não seja armazenada em cache.
As funções afetadas incluem stat(), lstat(), file_exists(), is_writable(), is_readable(), is_executable(), is_file(), is_dir(), is_link(), filectime(), fileatime(), filemtime(), fileinode(), filegroup(), fileowner(), filesize(), filetype(), e fileperms().
clear_realpath_cacheSe deve-se também limpar o cache de caminho real.
filename
Limpa o cache de caminho real para um arquivo específico somente; apenas
usado se clear_realpath_cache for true.
Nenhum valor é retornado.
Exemplo #1 Exemplo de 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));
?>O exemplo acima produzirá algo semelhante a:
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.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-sessionsclearstatcache() does not canonicalize the path. clearstatcache(true, "/a/b/c") is different from clearstatcache(true, "/a/b//c").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.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 :-( ).