mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
091df5f2d1
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@295782 c90b9560-bf6c-de11-be94-00142212c4b1
120 lines
3.5 KiB
XML
120 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.wincache-ucache-dec" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>wincache_ucache_dec</refname>
|
|
<refpurpose>
|
|
Decrements the value associated with the key
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>wincache_ucache_dec</methodname>
|
|
<methodparam><type>string</type><parameter>key</parameter></methodparam>
|
|
<methodparam choice="opt"><type>long</type><parameter>dec_by</parameter><initializer>1</initializer></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter role="reference">success</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Decrements the value associated with the <parameter>key</parameter> by 1 or as specified
|
|
by <parameter>dec_by</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <parameter>key</parameter> that was used to store the variable in the cache.
|
|
<parameter>key</parameter> is case sensitive.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>dec_by</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The value by which the variable associated with the <parameter>key</parameter> will get decremented.
|
|
If the argument is a floating point number it will be truncated to nearest integer. The variable
|
|
associated with the <parameter>key</parameter> should be of type <literal>long</literal>, otherwise
|
|
the function fails and returns <literal>FALSE</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>success</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Will be set to <literal>TRUE</literal> on success and <literal>FALSE</literal> on failure.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<simpara>
|
|
Returns the decremented value on success and <literal>FALSE</literal> on failure.
|
|
</simpara>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Using <function>wincache_ucache_dec</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
wincache_ucache_set('counter', 1);
|
|
var_dump(wincache_ucache_dec('counter', 2923, $success));
|
|
var_dump($success);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
int(2922)
|
|
bool(true)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>wincache_ucache_inc</function></member>
|
|
<member><function>wincache_ucache_cas</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
|
|
-->
|