php-doc-en/reference/wincache/functions/wincache-refresh-if-changed.xml
Richard Quadling 8d35d25579 Added Revision keyword
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@290986 c90b9560-bf6c-de11-be94-00142212c4b1
2009-11-19 12:51:58 +00:00

109 lines
3.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.wincache-refresh-if-changed" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>wincache_refresh_if_changed</refname>
<refpurpose>
Refreshes the cache entries for the cached files
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>wincache_refresh_if_changed</methodname>
<methodparam choice="opt"><type>array</type><parameter>files</parameter></methodparam>
</methodsynopsis>
<para>
Refreshes the cache entries for the files, whose names were passed in the input argument.
If no argument is specified then refreshes all the entries in the cache.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>files</parameter></term>
<listitem>
<para>
An array of file names for files that need to be refreshed.
An absolute or relative file paths can be used.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
WinCache performs regular checks on the cached files to
ensure that if any file has changed then the corresponding entry in the cache is
updated. By default this check is performed every 30 seconds. If, for example,
a PHP script updates another PHP script where the application's
configuration settings are stored, then it may happen that after the
configuration settings have been saved to a file, the application is still using
old settings for some time until the cache is refreshed. In those cases it may be
preferrable to refresh the cache right after the file has been changed. The
following example shows how this can be done.
<example>
<title>A <function>wincache_refresh_if_changed</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$filename = 'C:\inetpub\wwwroot\config.php';
$handle = fopen($filename, 'w+');
if ($handle === FALSE) die('Failed to open file '.$filename.' for writing');
fwrite($handle, '<?php $setting=something; ?>');
fclose($handle);
wincache_refresh_if_changed(array($filename));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>wincache_fcache_fileinfo</function></member>
<member><function>wincache_fcache_meminfo</function></member>
<member><function>wincache_ocache_fileinfo</function></member>
<member><function>wincache_ocache_meminfo</function></member>
<member><function>wincache_rplist_fileinfo</function></member>
<member><function>wincache_rplist_meminfo</function></member>
</simplelist>
</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
-->