/
apcu-store.xml
148 lines (144 loc) · 4.64 KB
/
apcu-store.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e9366ee458b2900c53a503b1ad97664e1d9a8859 Maintainer: satoruyoshida Status: ready -->
<refentry xml:id="function.apcu-store" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>apcu_store</refname>
<refpurpose>
変数をデータ領域にキャッシュする
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>apcu_store</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>mixed</type><parameter>var</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>ttl</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>array</type><methodname>apcu_store</methodname>
<methodparam><type>array</type><parameter>values</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>unused</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>ttl</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
変数をデータ領域にキャッシュします。
</para>
<note>
<simpara>
PHP の他の多くの仕組みと異なり、<function>apcu_store</function>
を用いて格納された変数はリクエストを超えて
（その値がキャッシュから取り除かれるまで）持続します。
</simpara>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
この名前を用いて変数を格納します。<parameter>key</parameter> は
キャッシュ内で一意です。そのため、同一の <parameter>key</parameter>
で新しい値を格納すると、元の値は上書きされます。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>var</parameter></term>
<listitem>
<para>
格納する変数。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ttl</parameter></term>
<listitem>
<para>
有効期間。<parameter>var</parameter> は、キャッシュに
<parameter>ttl</parameter> 秒間だけ格納されます。
<parameter>ttl</parameter> が経過すると、格納されている変数は
（次のリクエスト時に）キャッシュから削除されます。
<parameter>ttl</parameter> が指定されていない（あるいは
<parameter>ttl</parameter> が <literal>0</literal> の場合）は、
キャッシュから手動で削除される・あるいはキャッシュに存在できなくなる
（clear, restart など）まで値が持続します。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>values</parameter></term>
<listitem>
<para>
名前をキー、変数を値に指定します。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
二番目の構文は、エラーになったキーを含む配列を返します。
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>apcu_store</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
$bar = 'BAR';
apcu_store('foo', $bar);
var_dump(apcu_fetch('foo'));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(3) "BAR"
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>apcu_add</function></member>
<member><function>apcu_fetch</function></member>
<member><function>apcu_delete</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
-->