php-doc-en/reference/opcache/functions/opcache-invalidate.xml
2013-09-25 16:11:18 +00:00

87 lines
2.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.opcache-invalidate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>opcache_invalidate</refname>
<refpurpose>Invalidates a cached script</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>boolean</type><methodname>opcache_invalidate</methodname>
<methodparam><type>string</type><parameter>script</parameter></methodparam>
<methodparam choice="opt"><type>boolean</type><parameter>force</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
This function invalidates a particular script from the opcode cache. If
<parameter>force</parameter> is unset or &false;, the script will only be
invalidated if the modification time of the script is newer than the cached
opcodes.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>script</parameter></term>
<listitem>
<para>
The path to the script being invalidated.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>force</parameter></term>
<listitem>
<para>
If set to &true;, the script will be invalidated regardless of whether
invalidation is necessary.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the opcode cache for <parameter>script</parameter> was
invalidated or if there was nothing to invalidate, or &false; if the opcode
cache is disabled.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>opcache_compile_file</function></member>
<member><function>opcache_reset</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
-->