Skip to content

Document errors and changes in 8.4 for XSL and XPath #4483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 23, 2025
Merged

Document errors and changes in 8.4 for XSL and XPath #4483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ace8ed
Document errors and changes in 8.4 for XSL and XPath
nielsdos Feb 22, 2025
ccc2245
section order
nielsdos Feb 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion reference/dom/domxpath/evaluate.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="domxpath.evaluate" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="domxpath.evaluate" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<refnamediv>
<refname>DOMXPath::evaluate</refname>
<refpurpose>
Expand Down Expand Up @@ -46,6 +46,7 @@
</variablelist>
</para>
</refsect1>
<xi:include xpointer="domxpath.query..errors" />
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Expand Down
29 changes: 29 additions & 0 deletions reference/dom/domxpath/query.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,35 @@
<methodname>DOMXPath::query</methodname> returns &false;.
</para>
</refsect1>
<refsect1 role="errors" xml:id="domxpath.query..errors">
&reftitle.errors;
<simpara>
The following errors are possible when using an expression that invokes
PHP callbacks.
</simpara>
<itemizedlist>
<listitem>
<simpara>
Throws an <exceptionname>Error</exceptionname> if
a PHP callback is invoked but there were no callbacks registered,
or if the named callback was not registered.
</simpara>
</listitem>
<listitem>
<simpara>
Throws a <exceptionname>TypeError</exceptionname> if
the <literal>php:function</literal> syntax is used and the handler
name is not a string.
</simpara>
</listitem>
<listitem>
<simpara>
Throws an <exceptionname>Error</exceptionname> if
a non-DOM object was returned from a callback.
</simpara>
</listitem>
</itemizedlist>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
Expand Down
4 changes: 3 additions & 1 deletion reference/dom/domxpath/registerphpfunctionns.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="domxpath.registerphpfunctionns" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="domxpath.registerphpfunctionns" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<refnamediv>
<refname>DOMXPath::registerPhpFunctionNS</refname>
<refpurpose>Register a PHP functions as namespaced XPath function</refpurpose>
Expand Down Expand Up @@ -53,6 +53,8 @@
</variablelist>
</refsect1>

<xi:include xpointer="domxpath.registerphpfunctions..errors" />

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Expand Down
28 changes: 28 additions & 0 deletions reference/dom/domxpath/registerphpfunctions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,25 @@
</para>
</refsect1>

<refsect1 role="errors" xml:id="domxpath.registerphpfunctions..errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
Throws a <exceptionname>ValueError</exceptionname> if
a callback name is not valid.
</simpara>
</listitem>
&dom.errors.compliant.common;
<listitem>
<simpara>
Throws a <exceptionname>TypeError</exceptionname> if
a given callback is not callable.
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand All @@ -59,6 +78,15 @@
</row>
</thead>
<tbody>
<row xml:id="domxpath.registerphpfunctions..changelog.errors">
<entry>8.4.0</entry>
<entry>
Invalid callback names now throws a
<exceptionname>ValueError</exceptionname>.
Passing a non-callable entry now throws a
<exceptionname>TypeError</exceptionname>.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
Expand Down
4 changes: 3 additions & 1 deletion reference/xsl/xsltprocessor/registerphpfunctionns.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="xsltprocessor.registerphpfunctionns" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="xsltprocessor.registerphpfunctionns" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<refnamediv>
<refname>XSLTProcessor::registerPHPFunctionNS</refname>
<refpurpose>Register a PHP function as namespaced XSLT function</refpurpose>
Expand Down Expand Up @@ -50,6 +50,8 @@
</variablelist>
</refsect1>

<xi:include xpointer="domxpath.registerphpfunctions..errors" />

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Expand Down
5 changes: 4 additions & 1 deletion reference/xsl/xsltprocessor/registerphpfunctions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="xsltprocessor.registerphpfunctions" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="xsltprocessor.registerphpfunctions" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<refnamediv>
<refname>XSLTProcessor::registerPHPFunctions</refname>
<refpurpose>Enables the ability to use PHP functions as XSLT functions</refpurpose>
Expand Down Expand Up @@ -40,6 +40,8 @@
</para>
</refsect1>

<xi:include xpointer="domxpath.registerphpfunctions..errors" />

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Expand All @@ -58,6 +60,7 @@
</row>
</thead>
<tbody>
<xi:include xpointer="domxpath.registerphpfunctions..changelog.errors" />
<row>
<entry>8.4.0</entry>
<entry>
Expand Down
27 changes: 5 additions & 22 deletions reference/xsl/xsltprocessor/transformtodoc.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="xsltprocessor.transformtodoc" xmlns="http://docbook.org/ns/docbook">
<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>
Expand Down Expand Up @@ -45,34 +45,17 @@
</variablelist>
</para>
</refsect1>

<xi:include xpointer="domxpath.query..errors" />

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The resulting document or &false; on error.
</para>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
Added support for <classname>Dom\Document</classname>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<xi:include xpointer="xsltprocessor.transformtouri..changelog" />

<refsect1 role="examples">
&reftitle.examples;
Expand Down
13 changes: 11 additions & 2 deletions reference/xsl/xsltprocessor/transformtouri.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="xsltprocessor.transformtouri" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="xsltprocessor.transformtouri" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<refnamediv>
<refname>XSLTProcessor::transformToUri</refname>
<refpurpose>Transform to URI</refpurpose>
Expand Down Expand Up @@ -42,14 +42,16 @@
</para>
</refsect1>

<xi:include xpointer="domxpath.query..errors" />

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of bytes written or &false; if an error occurred.
</para>
</refsect1>

<refsect1 role="changelog">
<refsect1 role="changelog" xml:id="xsltprocessor.transformtouri..changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
Expand All @@ -60,6 +62,13 @@
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
Now throws an <exceptionname>Error</exceptionname> if the callback
cannot be invoked, instead of emitting a warning.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
Expand Down
25 changes: 4 additions & 21 deletions reference/xsl/xsltprocessor/transformtoxml.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,34 +21,17 @@
<xi:fallback/>
</xi:include>
</refsect1>

<xi:include xpointer="domxpath.query..errors" />

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The result of the transformation as a string or &false; on error.
</para>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
Added support for <classname>Dom\Document</classname>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<xi:include xpointer="xsltprocessor.transformtouri..changelog" />

<refsect1 role="examples">
&reftitle.examples;
Expand Down
Loading