Files
doc-fr/reference/dom/domxpath/query.xml
George Peter Banyard 1b9e26036b Apply commit 926842882dbed9c74ab7b951e78db96d42ee43ea
Generate dom methodsynopses based on stubs

Drive-by typo fix of noeud into nœud
2021-01-08 02:15:13 +00:00

172 lines
4.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 926842882dbed9c74ab7b951e78db96d42ee43ea Maintainer: jpauli Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="domxpath.query" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DOMXPath::query</refname>
<refpurpose>
Évalue l'expression XPath donnée
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>DOMXPath::query</methodname>
<methodparam><type>string</type><parameter>expression</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>DOMNode</type><type>null</type></type><parameter>contextNode</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>registerNodeNS</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
Évalue l'expression <parameter>expression</parameter> XPath donnée.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>expression</parameter></term>
<listitem>
<para>
L'expression XPath à exécuter.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>contextNode</parameter></term>
<listitem>
<para>
Le paramètre optionnel <parameter>contextNode</parameter> peut être spécifié
pour effectuer des requêtes XPath relative. Par défaut, les requêtes sont relatives
à l'élément racine.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>registerNodeNS</parameter></term>
<listitem>
<para>
Le paramètre optionnel <parameter>registerNodeNS</parameter> peut être
renseigné pour désactiver l'enregistrement automatique du nœud de
contexte.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne un <classname>DOMNodeList</classname> contenant tous les nœuds
correspondant à l'expression <parameter>expression</parameter> XPath donnée.
Toutes les expressions qui ne retournent pas de nœud retourneront
un <classname>DOMNodeList</classname> vide.
</para>
<para>
Si le paramètre <parameter>expression</parameter> est malformé ou
le paramètre <parameter>contextNode</parameter> est invalide,
<methodname>DOMXPath::query</methodname> retournera &false;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Récupération de tous les livres anglais</title>
<programlisting role="php">
<![CDATA[
<?php
$doc = new DOMDocument;
// Nous ne voulons pas nous soucier des espaces blancs
$doc->preserveWhiteSpace = false;
$doc->load('book.xml');
$xpath = new DOMXPath($doc);
// Nous commençons à l'élément racine
$query = '//book/chapter/para/informaltable/tgroup/tbody/row/entry[. = "en"]';
$entries = $xpath->query($query);
foreach ($entries as $entry) {
echo "Livre trouvé {$entry->previousSibling->previousSibling->nodeValue}," .
" par {$entry->previousSibling->nodeValue}\n";
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Livre trouvé : The Grapes of Wrath, par John Steinbeck
Livre trouvé : The Pearl, par John Steinbeck
]]>
</screen>
<para>
Nous pouvons également utiliser le paramètre <parameter>contextNode</parameter>
pour raccourcir notre expression :
</para>
<programlisting role="php">
<![CDATA[
<?php
$doc = new DOMDocument;
$doc->preserveWhiteSpace = false;
$doc->load('book.xml');
$xpath = new DOMXPath($doc);
$tbody = $doc->getElementsByTagName('tbody')->item(0);
// notre requête est relative au nœud tbody
$query = 'row/entry[. = "en"]';
$entries = $xpath->query($query, $tbody);
foreach ($entries as $entry) {
echo "Livre trouvé : {$entry->previousSibling->previousSibling->nodeValue}," .
" par {$entry->previousSibling->nodeValue}\n";
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>DOMXPath::query</methodname></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
-->