Feature #4789: Throw exceptions instead of silently returning null - SaxonC - Saxonica Developer Community

Actions

Send by e-mail Copy link

Feature #4789

closed

Throw exceptions instead of silently returning null

Added by Peter Jan about 4 years ago. Updated almost 3 years ago.

Status:

Closed

Priority:

Normal

Assignee:

O'Neil Delpratt

Category:

Documentation

Start date:

2020-10-08

Due date:

% Done:

100%

Estimated time:

Applies to branch:

Fix Committed on Branch:

Fixed in Maintenance Release:

Found in version:

1.2.1

Fixed in version:

11.1

SaxonC Languages:

SaxonC Platforms:

SaxonC Architecture:

Description

I'm trying to find the namespace of an XML file with:

$saxonProc = new SaxonProcessor();
$xPathProcessor = $saxonProc->newXPathProcessor();
$xPathProcessor->setContextFile($file->getPathname());
$item = $xPathProcessor->evaluateSingle('/*/namespace::*[name()=\'\']');

According to the documentation:

evaluateSingle(string $xpathStr)
Compile and evaluate an XPath expression whose result is expected to be a single item, with a given context item. The expression is supplied as a character string, and the result returned as an XdmItem.

So the return value is expected to be an XdmItem. However, when the expression could not be evaluated, it can also return null.

It would be great if exceptions can be thrown when these situations occur. (I expect these can be applied on other functions as well?), so these exceptions can be caught with a try-catch block. Now, the return type is not documented, but 'silently' returning a null value is also not desirable.

Actions

Copy link

Updated by Michael Kay about 4 years ago

Assignee set to O'Neil Delpratt

I think this is more of a documentation issue than anything else. Your XPath expression is perfectly valid and returns an empty sequence. The interface documentation for evaluateSingle should be clearer about exactly what happens when the XPath result is not a single item (i.e. when it's empty, or when there's more than one item in the result).

Actions

Copy link

Updated by O'Neil Delpratt about 4 years ago

Category set to Documentation

Hi, in the first instance I will follow through with comment #1 by updating the documentation for this method:

return null if the expression returns an empty sequence. If the expression returns a sequence of more than one item, any items after the first are ignored.

If I was to always expect to find a value, then maybe throwing an exception would be more useful. We do welcome suggestions, but I would think that returning a null is valid in this situaton as it is not an error for the XPath expression nothing is selected. Here we represent the empty sequence with a null.

Actions

Copy link

Updated by Peter Jan about 4 years ago

Hi, thank you both for your response.

Im perfectly fine with just updating the documentation, that will help. I'm not sure if this is limited to the evaluateSingle method, but ill leave that to your estimate.

If you can let me know when this has been resolved, Ill send a PR to https://github.com/JetBrains/phpstorm-stubs.

Actions

Copy link