Files
doc-fr/reference/yaml/functions/yaml-parse-url.xml
2021-06-08 16:49:14 +01:00

132 lines
4.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b8758b0605e80c4e3610137b7502a6abeea5c69b Maintainer: yannick Status: ready -->
<!-- Reviewed: yes Maintainer: yannick -->
<refentry xml:id="function.yaml-parse-url" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>yaml_parse_url</refname>
<refpurpose>Analyse un flux YAML depuis une URL</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>yaml_parse_url</methodname>
<methodparam><type>string</type><parameter>url</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pos</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">ndocs</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>callbacks</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Convertit tout ou partie d'un document YAML provenant d'une URL vers une
variable PHP.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>url</parameter></term>
<listitem>
<para>
<parameter>url</parameter> doit être de la forme "scheme://...". PHP
cherchera le protocole pour cette URL. Si aucun protocole n'a été
enregistré pour ce flux, PHP émettra une notice pour vous aider à
trouver le problème et continuera.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pos</parameter></term>
<listitem>
<para>
Le document à extraire du flux (<literal>-1</literal> pour tous les
documents, <literal>0</literal> pour le premier, ...).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ndocs</parameter></term>
<listitem>
<para>
Si <parameter>ndocs</parameter> est fourni, alors il est rempli avec
le nombre de documents trouvés dans le flux.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callbacks</parameter></term>
<listitem>
<para>
Analyseurs de contenu pour les nœuds YAML. Tableau associatif tag YAML
=&gt; <type>callable</type>. Voir
<link linkend="yaml.callbacks.parse">l'analyse des fonctions de rappel</link>
pour plus d'informations.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne la valeur encodée de <parameter>url</parameter> dans le type PHP
approprié&return.falseforfailure;.
Si <parameter>pos</parameter> vaut <literal>-1</literal>, un tableau sera retourné
avec pour chaque valeur, un document trouvé dans le flux.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<warning>
<para>
Le fait de traiter une entrée utilisateur non sécurisée avec
<function>yaml_parse_url</function> est dangereux si l'utilisation de
<function>unserialize</function> est activé pour les nœuds utilisant
la balise <literal>!php/object</literal>. Ce comportement peut être
désactivé en utilisant la configuration ini
<literal>yaml.decode_php</literal>.
</para>
</warning>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>yaml_parse</function></member>
<member><function>yaml_parse_file</function></member>
<member><function>yaml_emit</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
-->