mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-25 13:28:56 +00:00
b618a856b1
The function has always returned a boolean, and has always accepted either a string containing a single key name, an array of key names, or an APCUIterator containing a regular expression. -- Provided by anonymous 76182 (andrew@nicols.co.uk) git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@340328 c90b9560-bf6c-de11-be94-00142212c4b1
103 lines
2.5 KiB
XML
103 lines
2.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.apcu-delete" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>apcu_delete</refname>
|
|
<refpurpose>
|
|
Removes a stored variable from the cache
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>apcu_delete</methodname>
|
|
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Removes a stored variable from the cache.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A <parameter>key</parameter> used to store the value as a
|
|
<type>string</type> for a single key,
|
|
or as an <type>array</type> of strings for several keys,
|
|
or as an <classname>APCUIterator</classname> <type>object</type>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>apcu_delete</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$bar = 'BAR';
|
|
apcu_store('foo', $bar);
|
|
apcu_delete('foo');
|
|
// this is obviously useless in this form
|
|
|
|
// Alternatively delete multiple keys.
|
|
apcu_delete(['foo', 'bar', 'baz']);
|
|
|
|
// Or use an Iterator with a regular expression.
|
|
apcu_delete(new APCUIterator('#^myprefix_#'));
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>apcu_store</function></member>
|
|
<member><function>apcu_fetch</function></member>
|
|
<member><function>apcu_clear_cache</function></member>
|
|
<member><classname>APCUIterator</classname></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
|
|
-->
|