-
Notifications
You must be signed in to change notification settings - Fork 82
Expand file tree
/
Copy pathset.xml
More file actions
183 lines (167 loc) · 5.92 KB
/
set.xml
File metadata and controls
183 lines (167 loc) · 5.92 KB
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f4098e2bac4bcc136b95b85badcf4476fa683477 Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="memcache.set">
<refnamediv>
<refname>Memcache::set</refname>
<refname>memcache_set</refname>
<refpurpose>データをサーバーに格納する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>Memcache::set</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>mixed</type><parameter>var</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>expire</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>memcache_set</methodname>
<methodparam><type>Memcache</type><parameter>memcache</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>mixed</type><parameter>var</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>expire</parameter></methodparam>
</methodsynopsis>
<para>
<function>Memcache::set</function> は、キー
<parameter>key</parameter> に <parameter>var</parameter> という値を
関連付け、memcached サーバーに格納します。パラメータ <parameter>expire</parameter>
は、データの有効期限を秒単位で指定します。もし 0 を指定した場合は
その項目が期限切れになることはありません (これは、その項目のデータが
memcached サーバー上にずっと残り続けることを保証するものではありません。
他の項目をキャッシュするための場所を確保するためにサーバーから
削除されてしまうこともあります)。
(zlib を使用して) その場でのデータの圧縮を行いたい場合は、
<parameter>flag</parameter> の値として、定数
<constant>MEMCACHE_COMPRESSED</constant> を指定します。
<note>
<simpara>
リソース型の変数 (たとえばファイル記述子や接続記述子など)
はキャッシュに保存できないことを覚えておきましょう。これは、
シリアライズした状態ではそれらのデータを適切に表すことが
できないためです。
</simpara>
</note>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<simpara>
項目に関連付けられたキー。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>var</parameter></term>
<listitem>
<simpara>
格納する値。文字列および整数値はそのままの形式で、それ以外の型は
シリアライズされて格納されます。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flag</parameter></term>
<listitem>
<simpara>
項目を圧縮して格納する場合に <constant>MEMCACHE_COMPRESSED</constant>
を使用します (zlib を使用します)。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>expire</parameter></term>
<listitem>
<simpara>
項目の有効期限。ゼロの場合は有効期限なし (いつまでも有効)
となります。Unix タイムスタンプ形式、あるいは現在からの
秒数で指定することが可能ですが、後者の場合は秒数が
2592000 (30 日) を超えることはできません。
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.success;
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>Memcache::set</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
/* 手続き型の API */
/* memcached サーバーに接続します */
$memcache_obj = memcache_connect('memcache_host', 11211);
/*
キー 'var_key' の項目の値を設定します。
flag の値として 0 を使用し、圧縮は使用しません。
有効期限は 30 秒です。
*/
memcache_set($memcache_obj, 'var_key', 'some variable', 0, 30);
echo memcache_get($memcache_obj, 'var_key');
?>
]]>
</programlisting>
</example>
<example>
<title><function>Memcache::set</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
/* オブジェクト指向の API */
$memcache_obj = new Memcache;
/* memcached サーバーに接続します */
$memcache_obj->connect('memcache_host', 11211);
/*
キー 'var_key' に対応する値を設定します。その際、データの圧縮を行います。
有効期限は 50 秒です。
*/
$memcache_obj->set('var_key', 'some really big variable', MEMCACHE_COMPRESSED, 50);
echo $memcache_obj->get('var_key');
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>Memcache::add</function></member>
<member><function>Memcache::replace</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
-->