<?xml version="1.0" encoding="utf-8"?>

<refentry xmlns="http://docbook.org/ns/docbook" xml:id="memcache.replace">

<refnamediv>

<refname>Memcache::replace</refname>

<refname>memcache_replace</refname>

<refpurpose>既存項目の値を置換する</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>bool</type><methodname>Memcache::replace</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_replace</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>

<simpara>

<function>Memcache::replace</function> は、<parameter>key</parameter>

に対応する既存項目の値を置換するために使用します。

指定したキーに対応する項目がない場合は、

<function>Memcache::replace</function> は &false; を返します。

それ以外の点では、<function>Memcache::replace</function>

の振る舞いは <function>Memcache::set</function> と同じです。

</simpara>

</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;

<example>

<title><function>Memcache::replace</function> の例</title>

<programlisting role="php">

</programlisting>

</example>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<simplelist>

<member><function>Memcache::set</function></member>

<member><function>Memcache::add</function></member>

</simplelist>

</refsect1>

</refentry>