Files
archived-doc-pt-br/reference/simplexml/functions/simplexml-load-string.xml
Leonardo Lara Rodrigues 70d4f99f47 sync with en rev
2026-01-09 09:54:04 -03:00

179 lines
5.1 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: c142be811735a5542c8a2e4c4ed2f81e8cc3acc6 Maintainer: leonardolara Status: ready --><!-- CREDITS: rafa, fabioluciano, fernandowobeto, leonardolara -->
<refentry xml:id="function.simplexml-load-string" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>simplexml_load_string</refname>
<refpurpose>
Interpreta uma string XML e a transforma em um objeto
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>SimpleXMLElement</type><type>false</type></type><methodname>simplexml_load_string</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>class_name</parameter><initializer><constant>SimpleXMLElement::class</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>namespace_or_prefix</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_prefix</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
Recebe uma string XML bem-formada e a retorna como um objeto.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Uma string XML bem-formada
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>class_name</parameter></term>
<listitem>
<para>
Pode-se utilizar o parâmetro opcional
<function>simplexml_load_string</function>
para retornar um objeto da classe especificada.
Esta classe deve estender <type>SimpleXMLElement</type>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
&dom.parameter.options;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>namespace_or_prefix</parameter></term>
<listitem>
<para>
Prefixo ou URI do namespace.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>is_prefix</parameter></term>
<listitem>
<para>
&true; se <parameter>namespace_or_prefix</parameter> for um prefixo, &false; se for URI;
o padrão é &false;.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna um objeto (<type>object</type>) da classe <type>SimpleXMLElement</type> com
propriedades contendo os dados do documento XML,&return.falseforfailure;.
</para>
&return.falseproblem;
</refsect1>
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
Produz uma mensagem de erro <constant>E_WARNING</constant> para cada erro
encontrado nos dados XML.
</para>
<tip>
<para>
Utilize a função <function>libxml_use_internal_errors</function> para suprimir todos os
erros XML e a função <function>libxml_get_errors</function> para iterar sobre eles
posteriormente.
</para>
</tip>
</refsect1><!-- }}} -->
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Interpretar uma string XML</title>
<programlisting role="php">
<![CDATA[
<?php
$string = <<<XML
<?xml version='1.0'?>
<document>
<title>Forty What?</title>
<from>Joe</from>
<to>Jane</to>
<body>
I know that's the answer -- but what's the question?
</body>
</document>
XML;
$xml = simplexml_load_string($string);
print_r($xml);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
SimpleXMLElement Object
(
[title] => Forty What?
[from] => Joe
[to] => Jane
[body] =>
I know that's the answer -- but what's the question?
)
]]>
</screen>
<simpara>
Nesse ponto já é possível utilizar <literal>$xml-&gt;body</literal>
e afins.
</simpara>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>simplexml_load_file</function></member>
<member><methodname>SimpleXMLElement::__construct</methodname></member>
<member><xref linkend="simplexml.examples-errors"/></member>
<member><function>libxml_use_internal_errors</function></member>
<member><xref linkend="simplexml.examples-basic"/></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
-->