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

<refentry xml:id="function.unpack" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>unpack</refname>

<refpurpose>Déconditionne des données depuis une chaîne binaire</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>array</type><type>false</type></type><methodname>unpack</methodname>

<methodparam><type>string</type><parameter>format</parameter></methodparam>

<methodparam><type>string</type><parameter>string</parameter></methodparam>

<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>

</methodsynopsis>

<para>

Déconditionne les données

depuis une chaîne binaire avec le format <parameter>format</parameter>.

</para>

<para>

Les données déconditionnées sont stockées dans un

tableau. Pour cela, il faut donner un nom à chaque

format utilisé et les séparer par des slash (/). Si

un argument de répétition est présent, alors chacune des

clés du tableau aura un numéro de séquence derrière le

nom fourni.

</para>

<para>

Des modifications ont été effectuées pour aligner le comportement

de cette fonction avec Perl :

<simplelist>

<member>

Le code "a" ne supprime plus les octets NULL finaux.

</member>

<member>

Le code "A" supprime maintenant tous les espaces blancs ASCII finaux

(espace, tabulation, nouvelles lignes, retour à la ligne, et octets NULL).

</member>

<member>

Le code "Z" a été ajouté pour les chaînes complétées par des caractères

NULL, et supprime les octets NULL finaux.

</member>

</simplelist>

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>format</parameter></term>

<listitem>

<para>

Voir la fonction <function>pack</function> pour une explication des codes de format.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>string</parameter></term>

<listitem>

<para>

Les données conditionnées.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>offset</parameter></term>

<listitem>

<para>

La position où débuter le déconditionnement.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Retourne un tableau associatif contenant les éléments déconditionnés

d'une chaîne binaire, &return.falseforfailure;.

</para>

</refsect1>

<refsect1 role="changelog"><!-- {{{ -->

&reftitle.changelog;

<para>

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>7.2.0</entry>

<entry>

Les types <type>float</type> et <type>double</type> supportent à la fois l'orientation Big Endian et Little Endian.

</entry>

</row>

<row>

<entry>7.1.0</entry>

<entry>

La position <parameter>offset</parameter> optionnelle a été ajoutée.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1><!-- }}} -->

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Exemple avec <function>unpack</function></title>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</screen>

</example>

</para>

<para>

<example>

<title>Exemple avec <function>unpack</function> et un argument de répétition</title>

<programlisting role="php">

<![CDATA[

</programlisting>

&example.outputs;

<screen>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<caution>

<para>

Il faut noter que PHP gère les valeurs en interne

sous forme signée. Si on déconditionne

une valeur qui est aussi grande que la taille utilisée

en interne par PHP, le résultat se trouvera être

un nombre négatif, même s'il a été

déconditionné avec l'option <literal>" non signé "</literal>.

</para>

</caution>

<caution>

<para>

Si on ne nomme pas un élément, les index numériques à partir de

<literal>1</literal> sont utilisés. Sachez que si on a plus d'un

élément sans nom, certaines données sont écrasées parce que la numérotation

redémarre à partir de <literal>1</literal> pour chaque élément.

</para>

<para>

<example>

<title>Exemple avec <function>unpack</function> avec des clés non nommées</title>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</screen>

<para>

À noter que la première

valeur depuis le spécificateur <literal>c</literal> est écrasée

par la première valeur depuis le spécificateur <literal>n</literal>.

</para>

</example>

</para>

</caution>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>pack</function></member>

</simplelist>

</para>

</refsect1>

</refentry>