mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
94eb8e63be
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@300268 c90b9560-bf6c-de11-be94-00142212c4b1
137 lines
3 KiB
XML
137 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="function.apc-inc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>apc_inc</refname>
|
|
<refpurpose>Increase a stored number</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>apc_inc</methodname>
|
|
<methodparam><type>string</type><parameter>key</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>step</parameter><initializer>1</initializer></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter role="reference">success</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Increases a stored number.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The key of the value being increased.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>step</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The step, or value to increase.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>success</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Optionally pass the success or fail boolean value to
|
|
this referenced variable.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the current value of <parameter>key</parameter>'s value on success,
|
|
&return.falseforfailure;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>apc_inc</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
echo "Let's do something with success", PHP_EOL;
|
|
|
|
apc_store('anumber', 42);
|
|
|
|
echo apc_fetch('anumber'), PHP_EOL;
|
|
|
|
echo apc_inc('anumber'), PHP_EOL;
|
|
echo apc_inc('anumber', 10), PHP_EOL;
|
|
echo apc_inc('anumber', 10, $success), PHP_EOL;
|
|
|
|
var_dump($success);
|
|
|
|
echo "Now, let's fail", PHP_EOL, PHP_EOL;
|
|
|
|
apc_store('astring', 'foo');
|
|
|
|
$ret = apc_inc('astring', 1, $fail);
|
|
|
|
var_dump($ret);
|
|
var_dump($fail);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
42
|
|
43
|
|
53
|
|
63
|
|
bool(true)
|
|
Now, let's fail
|
|
|
|
bool(false)
|
|
bool(false)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>apc_dec</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|