cvs: phpdoc /en/reference/domxml/functions DomXsltStylesheet-process.xml DomXsltStylesheet-result-dump-file.xml DomXsltStylesheet-result-dump-mem.xml
domxml-xslt-stylesheet-doc.xml domxml-xslt-stylesheet-file.xml domxml-xslt-stylesheet.xml domxml-xslt-version.xml

didou Sat Jun 18 00:00:14 2005 EDT Added files: /phpdoc/en/reference/domxml/functions domxml-xslt-version.xml Modified files: /phpdoc/en/reference/domxml/functions DomXsltStylesheet-process.xml DomXsltStylesheet-result-dump-file.xml DomXsltStylesheet-result-dump-mem.xml domxml-xslt-stylesheet-doc.xml domxml-xslt-stylesheet-file.xml domxml-xslt-stylesheet.xml Log: Document ext/domxml XSLT related functions and add another one

http://cvs.php.net/diff.php/phpdoc/en/reference/domxml/functions/DomXsltStylesheet-process.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/domxml/functions/DomXsltStylesheet-process.xml diff -u phpdoc/en/reference/domxml/functions/DomXsltStylesheet-process.xml:1.8 phpdoc/en/reference/domxml/functions/DomXsltStylesheet-process.xml:1.9 --- phpdoc/en/reference/domxml/functions/DomXsltStylesheet-process.xml:1.8 Sun Jun 12 00:17:52 2005 +++ phpdoc/en/reference/domxml/functions/DomXsltStylesheet-process.xml Sat Jun 18 00:00:14 2005 @@ -1,32 +1,126 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> - <refentry id="function.domxsltstylesheet-process"> - <refnamediv> - <refname>DomXsltStylesheet->process</refname> - <refpurpose> - Applies the XSLT-Transformation on a DomDocument Object - </refpurpose> - </refnamediv> - <refsect1> - &reftitle.description; - <methodsynopsis> - <type>domdocument</type><methodname>DomXsltStylesheet->process</methodname> - <methodparam><type>domdocument</type><parameter>DomDocument</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>xslt_parameters</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>param_is_xpath</parameter></methodparam> - - </methodsynopsis> - &warn.undocumented.func; - - <para> - </para> - <para> - See also <function>domxml_xslt_stylesheet</function>, - <function>domxml_xslt_stylesheet_file</function>, and - <function>domxml_xslt_stylesheet_doc</function> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.9 $ --> +<refentry id="function.domxsltstylesheet-process"> + <refnamediv> + <refname>DomXsltStylesheet->process()</refname> + <refpurpose> + Applies the XSLT-Transformation on a DomDocument Object + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <classsynopsis> + <ooclass><classname>DomXsltStylesheet</classname></ooclass> + <methodsynopsis> + <type>DomDocument</type><methodname>process</methodname> + <methodparam><type>DomDocument</type><parameter>xml_doc</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>xslt_params</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>is_xpath_param</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>profile_filename</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + Applies an XSLT Transformation on the given + <classname>DomDocument</classname> object. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>xml_doc</parameter></term> + <listitem> + <para> + The XML document being transformed, as a + <classname>DomDocument</classname> object. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>xslt_params</parameter></term> + <listitem> + <para> + An associative array that takes pairs of parameter names and values. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>is_xpath_param</parameter></term> + <listitem> + <para> + If set to &false; the values of the <parameter>xslt_params</parameter> + will be quoted. This is the default behavior. It allows you to pass + the values as PHP strings. + </para> + <note> + <para> + If your strings contains both single and double quotes, you must take + care of quoting all the values by yourself and set this parameter to + &true;. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>profile_filename</parameter></term> + <listitem> + <para> + Set this to the path of a filename, if you want profiling information. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the result of the processing, as a + <classname>DomDocument</classname> object. + </para> + </refsect1> + <refsect1 role="migration"> + <title>Migrating to PHP 5</title> + <para> + Use <xref linkend="function.xsl-xsltprocessor-set-parameter" /> and + <xref linkend="function.xsl-xsltprocessor-transform-to-doc" />. + </para> + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.0</entry> + <entry> + The <parameter>profile_filename</parameter> parameter was added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>domxml_xslt_stylesheet</function></member> + <member><function>domxml_xslt_stylesheet_file</function></member> + <member><function>domxml_xslt_stylesheet_doc</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/domxml/functions/DomXsltStylesheet-result-dump-file.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/domxml/functions/DomXsltStylesheet-result-dump-file.xml diff -u phpdoc/en/reference/domxml/functions/DomXsltStylesheet-result-dump-file.xml:1.7 phpdoc/en/reference/domxml/functions/DomXsltStylesheet-result-dump-file.xml:1.8 --- phpdoc/en/reference/domxml/functions/DomXsltStylesheet-result-dump-file.xml:1.7 Sun Jun 12 00:17:52 2005 +++ phpdoc/en/reference/domxml/functions/DomXsltStylesheet-result-dump-file.xml Sat Jun 18 00:00:14 2005 @@ -1,35 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> - <refentry id="function.domxsltstylesheet-result-dump-file"> - <refnamediv> - <refname>DomXsltStylesheet->result_dump_file</refname> - <refpurpose> - Dumps the result from a XSLT-Transformation into a file - </refpurpose> - </refnamediv> - <refsect1> - &reftitle.description; - <methodsynopsis> - <type>string</type><methodname>DomXsltStylesheet->result_dump_file</methodname> - <methodparam><type>domdocument</type><parameter>DomDocument</parameter></methodparam> - <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> - - <para> - This function is only available since PHP 4.3 - </para> - <para> - Since DomXsltStylesheet->process() always returns a well-formed XML DomDocument, - no matter what output method was declared in <![CDATA[<xsl:output>]]> and similar - attributes/elements, it's of not much use, if you want to output HTML 4 or text data. - This function on the contrary honors <![CDATA[<xsl:output method="html|text">]]> - and other output control directives. See the example for instruction of how to use it. - </para> - <para> - <example> - <title>Saving the result of a XSLT transformation in a file</title> - <programlisting role="php"> +<!-- $Revision: 1.8 $ --> +<refentry id="function.domxsltstylesheet-result-dump-file"> + <refnamediv> + <refname>DomXsltStylesheet->result_dump_file</refname> + <refpurpose> + Dumps the result from a XSLT-Transformation into a file + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <classsynopsis> + <ooclass><classname>DomXsltStylesheet</classname></ooclass> + <methodsynopsis> + <type>string</type><methodname>result_dump_file</methodname> + <methodparam><type>DomDocument</type><parameter>xmldoc</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + Since <xref linkend="function.domxsltstylesheet-process" /> always returns a + well-formed XML DomDocument, no matter what output method was declared in + <![CDATA[<xsl:output>]]> and similar attributes/elements, it's of not much use, + if you want to output HTML 4 or text data. + </para> + <para> + This function on the contrary honors <![CDATA[<xsl:output method="html|text">]]> + and other output control directives. See the example for instruction on how to use it. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Saving the result of a XSLT transformation in a file</title> + <programlisting role="php"> <![CDATA[ <?php $filename = "stylesheet.xsl"; @@ -39,15 +43,20 @@ echo $xsldoc->result_dump_file($result, "filename"); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>domxml_xslt_result_dump_mem</function>, and - <function>domxml_xslt_process</function> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><xref linkend="function.domxsltstylesheet-result-dump-mem" /></member> + <member><xref linkend="function.domxsltstylesheet-process" /></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/domxml/functions/DomXsltStylesheet-result-dump-mem.xml?r1=1.9&r2=1.10&ty=u Index: phpdoc/en/reference/domxml/functions/DomXsltStylesheet-result-dump-mem.xml diff -u phpdoc/en/reference/domxml/functions/DomXsltStylesheet-result-dump-mem.xml:1.9 phpdoc/en/reference/domxml/functions/DomXsltStylesheet-result-dump-mem.xml:1.10 --- phpdoc/en/reference/domxml/functions/DomXsltStylesheet-result-dump-mem.xml:1.9 Sun Jun 12 00:17:52 2005 +++ phpdoc/en/reference/domxml/functions/DomXsltStylesheet-result-dump-mem.xml Sat Jun 18 00:00:14 2005 @@ -1,34 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> - <refentry id="function.domxsltstylesheet-result-dump-mem"> - <refnamediv> - <refname>DomXsltStylesheet->result_dump_mem</refname> - <refpurpose> - Dumps the result from a XSLT-Transformation back into a string - </refpurpose> - </refnamediv> - <refsect1> - &reftitle.description; - <methodsynopsis> - <type>string</type><methodname>DomXsltStylesheet->result_dump_mem</methodname> - <methodparam><type>domdocument</type><parameter>DomDocument</parameter></methodparam> - - </methodsynopsis> - - <para> - This function is only available since PHP 4.3 - </para> - <para> - Since DomXsltStylesheet->process() always returns a well-formed XML DomDocument, - no matter what output method was declared in <![CDATA[<xsl:output>]]> and similar - attributes/elements, it's of not much use, if you want to output HTML 4 or text data. - This function on the contrary honors <![CDATA[<xsl:output method="html|text">]]> - and other output control directives. See the example for instruction of how to use it. - </para> - <para> - <example> - <title>Outputting the result of a XSLT transformation</title> - <programlisting role="php"> +<!-- $Revision: 1.10 $ --> +<refentry id="function.domxsltstylesheet-result-dump-mem"> + <refnamediv> + <refname>DomXsltStylesheet->result_dump_mem()</refname> + <refpurpose> + Dumps the result from a XSLT-Transformation back into a string + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <classsynopsis> + <ooclass><classname>DomXsltStylesheet</classname></ooclass> + <methodsynopsis> + <type>string</type><methodname>result_dump_mem</methodname> + <methodparam><type>DomDocument</type><parameter>xmldoc</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + Since <xref linkend="function.domxsltstylesheet-process" /> always returns + a well-formed XML DomDocument, no matter what output method was declared + in <![CDATA[<xsl:output>]]> and similar attributes/elements, it's of not + much use, if you want to output HTML 4 or text data. + This function on the contrary honors <![CDATA[<xsl:output method="html|text">]]> + and other output control directives. See the example for instruction of how to use it. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Outputting the result of a XSLT transformation</title> + <programlisting role="php"> <![CDATA[ <?php $filename = "stylesheet.xsl"; @@ -38,15 +40,20 @@ echo $xsldoc->result_dump_mem($result); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>domxml_xslt_result_dump_file</function>, and - <function>domxml_xslt_process</function> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><xref linkend="function.domxsltstylesheet-result-dump-file" /></member> + <member><xref linkend="function.domxsltstylesheet-process" /></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-doc.xml?r1=1.10&r2=1.11&ty=u Index: phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-doc.xml diff -u phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-doc.xml:1.10 phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-doc.xml:1.11 --- phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-doc.xml:1.10 Fri Jun 17 19:35:55 2005 +++ phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-doc.xml Sat Jun 18 00:00:14 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.domxml-xslt-stylesheet-doc"> <refnamediv> <refname>domxml_xslt_stylesheet_doc</refname> @@ -10,18 +10,47 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>XsltStylesheet</type><methodname>domxml_xslt_stylesheet_doc</methodname> - <methodparam><type>domdocument</type><parameter>DocDocumentObject</parameter></methodparam> + <type>DomXsltStylesheet</type><methodname>domxml_xslt_stylesheet_doc</methodname> + <methodparam><type>DomDocument</type><parameter>xsl_doc</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + Creates a <classname>DomXsltStylesheet</classname> object from the given + XSL document. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>xsl_doc</parameter></term> + <listitem> + <para> + The XSL document, as a <classname>DomDocument</classname> object. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a new instance of <classname>DomXsltStylesheet</classname>. + </para> + </refsect1> + <refsect1 role="migration"> + <title>Migrating to PHP 5</title> + <para> + Call <xref linkend="function.xsl-xsltprocessor-import-stylesheet" /> with + the <parameter>xsl_doc</parameter> parameter. + </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function>domxsltstylesheet->process</function></member> + <member><xref linkend="function.domxsltstylesheet-process" /></member> <member><function>domxml_xslt_stylesheet</function></member> <member><function>domxml_xslt_stylesheet_file</function></member> </simplelist> http://cvs.php.net/diff.php/phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-file.xml?r1=1.11&r2=1.12&ty=u Index: phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-file.xml diff -u phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-file.xml:1.11 phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-file.xml:1.12 --- phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-file.xml:1.11 Fri Jun 17 19:35:55 2005 +++ phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-file.xml Sat Jun 18 00:00:14 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <refentry id="function.domxml-xslt-stylesheet-file"> <refnamediv> <refname>domxml_xslt_stylesheet_file</refname> @@ -10,18 +10,47 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>XsltStylesheet</type><methodname>domxml_xslt_stylesheet_file</methodname> + <type>DomXsltStylesheet</type><methodname>domxml_xslt_stylesheet_file</methodname> <methodparam><type>string</type><parameter>xsl_file</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + Creates a <classname>DomXsltStylesheet</classname> object from the given + XSL file. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>xsl_file</parameter></term> + <listitem> + <para> + The path to the XSL document, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a new instance of <classname>DomXsltStylesheet</classname>. + </para> + </refsect1> + <refsect1 role="migration"> + <title>Migrating to PHP 5</title> + <para> + Call <xref linkend="function.xsl-xsltprocessor-import-stylesheet" /> with + <literal>DOMDocument::load($xsl_file)</literal> as parameter. + </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function>domxsltstylesheet->process</function></member> + <member><xref linkend="function.domxsltstylesheet-process" /></member> <member><function>domxml_xslt_stylesheet</function></member> <member><function>domxml_xslt_stylesheet_doc</function></member> </simplelist> http://cvs.php.net/diff.php/phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet.xml?r1=1.11&r2=1.12&ty=u Index: phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet.xml diff -u phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet.xml:1.11 phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet.xml:1.12 --- phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet.xml:1.11 Fri Jun 17 19:35:55 2005 +++ phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet.xml Sat Jun 18 00:00:14 2005 @@ -1,27 +1,56 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <refentry id="function.domxml-xslt-stylesheet"> <refnamediv> <refname>domxml_xslt_stylesheet</refname> <refpurpose> - Creates a DomXsltStylesheet Object from an XML document in a string + Creates a DomXsltStylesheet object from an XSL document in a string </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>XsltStylesheet</type><methodname>domxml_xslt_stylesheet</methodname> - <methodparam><type>string</type><parameter>xsl_document</parameter></methodparam> + <type>DomXsltStylesheet</type><methodname>domxml_xslt_stylesheet</methodname> + <methodparam><type>string</type><parameter>xsl_buf</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + Creates a <classname>DomXsltStylesheet</classname> object from the given + XSL buffer. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>xsl_buf</parameter></term> + <listitem> + <para> + The XSL document, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a new instance of <classname>DomXsltStylesheet</classname>. + </para> + </refsect1> + <refsect1 role="migration"> + <title>Migrating to PHP 5</title> + <para> + Call <xref linkend="function.xsl-xsltprocessor-import-stylesheet" /> with + <literal>DOMDocument::loadXML($xsl_buf)</literal> as parameter. + </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function>domxsltstylesheet->process</function></member> + <member><xref linkend="function.domxsltstylesheet-process" /></member> <member><function>domxml_xslt_stylesheet_file</function></member> <member><function>domxml_xslt_stylesheet_doc</function></member> </simplelist> http://cvs.php.net/co.php/phpdoc/en/reference/domxml/functions/domxml-xslt-version.xml?r=1.1&p=1 Index: phpdoc/en/reference/domxml/functions/domxml-xslt-version.xml +++ phpdoc/en/reference/domxml/functions/domxml-xslt-version.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.domxml-xslt-version"> <refnamediv> <refname>domxml_xslt_version</refname> <refpurpose> Gets the XSLT library version </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>domxml_xslt_version</methodname> <void/> </methodsynopsis> <para> Gets the XSLT library version. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the version number of the XSLT library, as an integer. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>domxml_xslt_version</function> Example</title> <programlisting role="php"> <![CDATA[ <?php echo domxml_xslt_version(); ?> ]]> </programlisting> &example.outputs.similar; <screen> <![CDATA[ 10112 ]]> </screen> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>domxml_version</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:"../../../../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 -->