clearstatcache.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e82ff8a846af03b863c4a57fbedc0a93af0e68db Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xml:id="function.clearstatcache" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>clearstatcache</refname>
  <refpurpose>ファイルのステータスのキャッシュをクリアする</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>clearstatcache</methodname>
   <methodparam choice="opt"><type>bool</type><parameter>clear_realpath_cache</parameter><initializer>&false;</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>filename</parameter><initializer>""</initializer></methodparam>
  </methodsynopsis>
  <para>
   <systemitem>stat</systemitem>や<systemitem>lstat</systemitem>、
   またはその他の関数（後述）を使用すると、PHPはパフォーマンス向上のために
   それらの関数の戻り値をキャッシュします。しかし、ケースによっては、
   キャッシュされた情報を消去したい場合もあるでしょう。
   例えば、一つのスクリプト上で同じファイルが何度もチェックされ、
   そのファイルが変更されたり削除されたりする可能性がある場合、
   ステータスキャッシュを消去しなければならないと感じるでしょう。
   このようなケースでは、<function>clearstatcache</function>を使用することで
   ファイルの情報に関してPHPが持っているキャッシュをクリアすることができます。
  </para>
  <para>
   PHP は存在しないファイルについての情報はキャッシュしないことにも
   注意してください。もし存在しないファイルに対して
   <function>file_exists</function> をコールする場合、ファイルを作成するまで
   この関数は &false; を返します。もしファイルを作成した場合、
   たとえファイルを削除したとしても &true; を返します。
   しかし、<function>unlink</function> はキャッシュを自動的にクリアします。
  </para>
  <note>
   <para>
    この関数は特定のファイルに関する情報をキャッシュします。したがって、
    同じファイルについて複数回の操作を行いそのファイルに関する情報を
    キャッシュされないようにするためには、
    <function>clearstatcache</function>をコールするだけです。
   </para>
  </note>
  <para>
   影響を受ける関数を以下に示します。
   <function>stat</function>,
   <function>lstat</function>,
   <function>file_exists</function>,
   <function>is_writable</function>,
   <function>is_readable</function>,
   <function>is_executable</function>,
   <function>is_file</function>,
   <function>is_dir</function>,
   <function>is_link</function>,
   <function>filectime</function>,
   <function>fileatime</function>,
   <function>filemtime</function>,
   <function>fileinode</function>,
   <function>filegroup</function>,
   <function>fileowner</function>,
   <function>filesize</function>,
   <function>filetype</function>, および
   <function>fileperms</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>clear_realpath_cache</parameter></term>
     <listitem>
      <para>
       realpath キャッシュ<emphasis>も</emphasis>クリアするかどうか。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       realpath キャッシュを特定のファイル名だけに対してクリアする。
       <parameter>clear_realpath_cache</parameter> が &true;
       の場合にのみ使用。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>clearstatcache</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?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));
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
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
]]>
    </screen>
   </example>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->