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

<!-- $Revision$ -->

<!-- EN-Revision: 7e6d80ad17ddaad007be2d981fc4bd6e75a042c7 Maintainer: yannick Status: ready -->

<!-- Reviewed: yes -->

<refentry xml:id="memcached.setoption" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<refnamediv>

<refname>Memcached::setOption</refname>

<refpurpose>Configure une option Memcached</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis role="Memcached">

<modifier>public</modifier> <type>bool</type><methodname>Memcached::setOption</methodname>

<methodparam><type>int</type><parameter>option</parameter></methodparam>

<methodparam><type>mixed</type><parameter>value</parameter></methodparam>

</methodsynopsis>

<para>

<function>Memcached::setOption</function> configure une valeur de l'option Memcached

<parameter>option</parameter> avec la valeur <parameter>value</parameter>.

Certaines options correspondent à celles définies dans libmemcached, et d'autres

sont spécifiques à l'extension.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>option</parameter></term>

<listitem>

<para>

Une des constantes <constant>Memcached::OPT_<replaceable>*</replaceable></constant>.

Voir <link linkend="memcached.constants">les constantes Memcached</link> pour plus d'informations.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>value</parameter></term>

<listitem>

<para>

La valeur à définir.

</para>

<note>

<para>

Les options ci-dessous nécessitent que les valeurs soient spécifiées via les constantes.

<simplelist>

<member>

<constant>Memcached::OPT_HASH</constant> nécessite des valeurs

<constant>Memcached::HASH_<replaceable>*</replaceable></constant>.

</member>

<member>

<constant>Memcached::OPT_DISTRIBUTION</constant> nécessite des valeurs

<constant>Memcached::DISTRIBUTION_<replaceable>*</replaceable></constant>.

</member>

<member>

<constant>Memcached::OPT_SERIALIZER</constant> nécessite des valeurs

<constant>Memcached::SERIALIZER_<replaceable>*</replaceable></constant>.

</member>

<member>

<constant>Memcached::OPT_COMPRESSION_TYPE</constant> nécessite des valeurs

<constant>Memcached::COMPRESSION_<replaceable>*</replaceable></constant>.

</member>

</simplelist>

</para>

</note>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

&return.success;

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Configuration d'une option Memcached</title>

<programlisting role="php">

<![CDATA[

<?php

$m = new Memcached();

var_dump($m->getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT);

$m->setOption(Memcached::OPT_HASH, Memcached::HASH_MURMUR);

$m->setOption(Memcached::OPT_PREFIX_KEY, "widgets");

echo "Le préfixe de la clé est maintenant : ", $m->getOption(Memcached::OPT_PREFIX_KEY), "\n";

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

bool(true)

Le préfixe de la clé est maintenant : widgets

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><methodname>Memcached::getOption</methodname></member>

<member><methodname>Memcached::setOptions</methodname></member>

<member><link linkend="memcached.constants">Les constantes Memcached</link></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

-->