archived-doc-pt-br/reference/dom/domxpath/query.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c1f37a6c270aadbbb3da56a3973ffd62197adf2b Maintainer: leonardolara Status: ready --><!-- CREDITS: fernandowobeto,leonardolara -->
<refentry xml:id="domxpath.query" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>DOMXPath::query</refname>
  <refpurpose>
   Avalia a expressão XPath fornecida
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="DOMXPath">
   <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>
   Executa a <parameter>expression</parameter> XPath fornecida.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>expression</parameter></term>
     <listitem>
      <para>
       A expressão XPath a ser executada.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>contextNode</parameter></term>
     <listitem>
      <para>
       O <parameter>contextNode</parameter> opcional pode ser especificado para
       realizar consultas XPath relativas. Por padrão, as consultas são relativas ao
       elemento raiz.
      </para>
     </listitem>
    </varlistentry>
    &dom.parameters.register_node_ns;
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retorna uma <classname>DOMNodeList</classname> contendo todos os nós que correspondem
   à <parameter>expression</parameter> XPath fornecida. Qualquer expressão que
   não retorne nós resultará em uma
   <classname>DOMNodeList</classname> vazia.
  </para>
  <para>
   Se a <parameter>expression</parameter> estiver malformada ou o
   <parameter>contextNode</parameter> for inválido,
   <methodname>DOMXPath::query</methodname> retorna &false;.
  </para>
 </refsect1>
 <refsect1 role="errors" xml:id="domxpath.query..errors">
  &reftitle.errors;
  <simpara>
   Os seguintes erros são possíveis ao usar uma expressão que invoca
   retornos de chamada PHP.
  </simpara>
  <itemizedlist>
   <listitem>
    <simpara>
     Lança um <exceptionname>Error</exceptionname> se
     um retorno de chamada do PHP for invocado, mas não houver nenhum retorno de chamada registrado
     ou se o retorno de chamada nomeado não tiver sido registrado.
    </simpara>
   </listitem>
   <listitem>
    <simpara>
     Lança um <exceptionname>TypeError</exceptionname> se
     a sintaxe <literal>php:function</literal> for usada e o nome do manipulador
     não for uma string.
    </simpara>
   </listitem>
   <listitem>
    <simpara>
     Lança um <exceptionname>Error</exceptionname> se
     um objeto não DOM foi retornado de um retorno de chamada.
    </simpara>
   </listitem>
  </itemizedlist>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Obtendo todos os livros em inglês</title>
    <programlisting role="php">
<![CDATA[
<?php

$doc = new DOMDocument;

// Não queremos nos preocupar com espaços em branco
$doc->preserveWhiteSpace = false;

$doc->load('examples/book-docbook.xml');

$xpath = new DOMXPath($doc);

// Começamos do elemento raiz
$query = '//book/chapter/para/informaltable/tgroup/tbody/row/entry[. = "en"]';

$entries = $xpath->query($query);

foreach ($entries as $entry) {
    echo "Found {$entry->previousSibling->previousSibling->nodeValue}," .
         " by {$entry->previousSibling->nodeValue}\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Found The Grapes of Wrath, by John Steinbeck
Found The Pearl, by John Steinbeck
]]>
    </screen>
    <para>
     Também podemos usar o parâmetro <parameter>contextNode</parameter> para encurtar
     nossa expressão:
    </para>
    <programlisting role="php">
<![CDATA[
<?php

$doc = new DOMDocument;
$doc->preserveWhiteSpace = false;

$doc->load('examples/book-docbook.xml');

$xpath = new DOMXPath($doc);

$tbody = $doc->getElementsByTagName('tbody')->item(0);

// nossa consulta é relativa ao nó tbody
$query = 'row/entry[. = "en"]';

$entries = $xpath->query($query, $tbody);

foreach ($entries as $entry) {
    echo "Found {$entry->previousSibling->previousSibling->nodeValue}," .
         " by {$entry->previousSibling->nodeValue}\n";
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>DOMXPath::evaluate</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
-->