File: DomXsltStylesheet-process.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (144 lines) | stat: -rw-r--r-- 4,128 bytes parent folder | download
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $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:
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
-->