1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="xsltprocessor.transformtodoc" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<refnamediv>
<refname>XSLTProcessor::transformToDoc</refname>
<refpurpose>Transform to a document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="XSLTProcessor">
<modifier>public</modifier> <type class="union"><type>object</type><type>false</type></type><methodname>XSLTProcessor::transformToDoc</methodname>
<methodparam><type>object</type><parameter>document</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>returnClass</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Transforms the source node to a document (e.g. <classname>DOMDocument</classname>) applying
the stylesheet given by the
<function>XSLTProcessor::importStylesheet</function> method.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>document</parameter></term>
<listitem>
<para>
The <classname>Dom\Document</classname>, <classname>DOMDocument</classname>, <classname>SimpleXMLElement</classname> or libxml-compatible
object to be transformed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>returnClass</parameter></term>
<listitem>
<para>
This optional parameter may be used so that
<methodname>XSLTProcessor::transformToDoc</methodname>
will return an object of the specified class.
That class should either extend or be the same class as <parameter>document</parameter>'s class.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<xi:include xpointer="domxpath.query..errors" />
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The resulting document or &false; on error.
</para>
</refsect1>
<xi:include xpointer="xsltprocessor.transformtouri..changelog" />
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Transforming to a <classname>DOMDocument</classname></title>
<programlisting role="php">
<![CDATA[
<?php
// Load the XML source
$xml = new DOMDocument;
$xml->load('collection.xml');
$xsl = new DOMDocument;
$xsl->load('collection.xsl');
// Configure the transformer
$proc = new XSLTProcessor;
$proc->importStyleSheet($xsl); // attach the xsl rules
echo trim($proc->transformToDoc($xml)->firstChild->wholeText);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Hey! Welcome to Nicolas Eliaszewicz's sweet CD collection!
]]>
</screen>
</example>
<example>
<title>Transforming to a <classname>Dom\Document</classname></title>
<programlisting role="php">
<![CDATA[
<?php
$xml = Dom\XMLDocument::createFromFile('collection.xml');
$xsl = Dom\XMLDocument::createFromFile('collection.xsl');
// Configure the transformer
$proc = new XSLTProcessor;
$proc->importStyleSheet($xsl); // attach the xsl rules
echo trim($proc->transformToDoc($xml)->firstChild->wholeText);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Hey! Welcome to Nicolas Eliaszewicz's sweet CD collection!
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>XSLTProcessor::transformToUri</function></member>
<member><function>XSLTProcessor::transformToXml</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
-->
|