[PHP-DOC] cvs: phpdoc /en/reference/filesystem/functions clearstatcache.xml From: Erica Douglass (erica <email protected>)
Date: 09/06/02

erica Fri Sep 6 02:43:13 2002 EDT

  Modified files:
    /phpdoc/en/reference/filesystem/functions clearstatcache.xml
  Log:
  Rewrote description of this function for clarity (check user notes -- no one knew what this function actually did. ;)
  
  
Index: phpdoc/en/reference/filesystem/functions/clearstatcache.xml
diff -u phpdoc/en/reference/filesystem/functions/clearstatcache.xml:1.2 phpdoc/en/reference/filesystem/functions/clearstatcache.xml:1.3
--- phpdoc/en/reference/filesystem/functions/clearstatcache.xml:1.2 Wed Apr 17 02:38:05 2002
+++ phpdoc/en/reference/filesystem/functions/clearstatcache.xml Fri Sep 6 02:43:13 2002
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
-<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.3 $ -->
+<!-- split from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.clearstatcache">
    <refnamediv>
     <refname>clearstatcache</refname>
- <refpurpose>Clears file stat cache</refpurpose>
+ <refpurpose>Clears file status cache</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
@@ -12,18 +12,20 @@
       <type>void</type><methodname>clearstatcache</methodname>
       <void/>
      </methodsynopsis>
- <para>
- Invoking the <systemitem>stat</systemitem> or
- <systemitem>lstat</systemitem> system call on most systems is
- quite expensive. Therefore, the result of the last call to any of
- the status functions (listed below) is stored for use on the next
- such call using the same filename. If you wish to force a new
- status check, for instance if the file is being checked many
- times and may change or disappear, use this function to clear the
- results of the last call from memory.
+ <para>
+ When you use <methodname>stat()</methodname>, <methodname>lstat()</methodname>, or any of the other functions listed in the affected functions
+ list (below), PHP caches the information those functions return in order to provide faster
+ performance. However, in certain cases, you may want to clear the cached information. For
+ instance, if the same file is being checked multiple times within a single script, and that file
+ is in danger of being removed or changed during that script's operation, you may elect to clear the
+ status cache. In these cases, you can use the <methodname>clearstatcache()</methodname> function to clear the information that PHP caches about a file.
     </para>
- <para>
- This value is only cached for the lifetime of a single request.
+ <note>
+ <para>
+ This function caches information about specific filenames, so you only need to call <methodname>clearstatcache()</methodname> if
+ you are performing multiple operations on the same filename and require the information about that
+ particular file to not be cached.
+ </note>
     </para>
     <para>
      Affected functions include <function>stat</function>, 

-- 
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php