xml-parser-free.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.xml-parser-free" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xml_parser_free</refname>
  <refpurpose>Free an XML parser</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xml_parser_free</methodname>
   <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
  </methodsynopsis>
  &note.resource-migration-8.0-dead-function;
  <para>
   Frees the given XML <parameter>parser</parameter>.
  </para>
  <caution>
   <para>
    In addition to calling <function>xml_parser_free</function> when the parsing
    is finished, prior to PHP 8.0.0, it was necessary to also explicitly unset the
    reference to <parameter>parser</parameter> to avoid memory leaks,
    if the parser resource is referenced from an object, and this object references
    that parser resource.
   </para>
  </caution>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <simpara>
       A reference to the XML parser to free.
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
      &xml.changelog.parser-param;
    </tbody>
   </tgroup>
  </informaltable>
 </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
-->